[0/2] Update links of LoongArch ISA Vol1 and ELF psABI

Message ID 1669892345-7763-1-git-send-email-yangtiezhu@loongson.cn
Headers
Series Update links of LoongArch ISA Vol1 and ELF psABI |

Message

Tiezhu Yang Dec. 1, 2022, 10:59 a.m. UTC
  Tiezhu Yang (2):
  docs/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
  docs/zh_CN/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI

 Documentation/loongarch/introduction.rst                    | 8 ++++----
 Documentation/translations/zh_CN/loongarch/introduction.rst | 8 ++++----
 2 files changed, 8 insertions(+), 8 deletions(-)
  

Comments

Jonathan Corbet Dec. 3, 2022, 10:58 a.m. UTC | #1
Tiezhu Yang <yangtiezhu@loongson.cn> writes:

> Tiezhu Yang (2):
>   docs/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
>   docs/zh_CN/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
>
>  Documentation/loongarch/introduction.rst                    | 8 ++++----
>  Documentation/translations/zh_CN/loongarch/introduction.rst | 8 ++++----
>  2 files changed, 8 insertions(+), 8 deletions(-)

I've applied these - working links are better than broken ones.  I
assume, though, that the new URLs, too, will break the next time the
manual is updated?  Is there any chance Loongson could provide a stable
URL for the current version of this manual instead?

Thanks,

jon
  
Xi Ruoyao Dec. 4, 2022, 5:50 a.m. UTC | #2
On Sat, 2022-12-03 at 03:58 -0700, Jonathan Corbet wrote:
> Tiezhu Yang <yangtiezhu@loongson.cn> writes:
> 
> > Tiezhu Yang (2):
> >    docs/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
> >    docs/zh_CN/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
> > 
> >   Documentation/loongarch/introduction.rst                    | 8 ++++----
> >   Documentation/translations/zh_CN/loongarch/introduction.rst | 8 ++++----
> >   2 files changed, 8 insertions(+), 8 deletions(-)
> 
> I've applied these - working links are better than broken ones.  I
> assume, though, that the new URLs, too, will break the next time the
> manual is updated?  Is there any chance Loongson could provide a stable
> URL for the current version of this manual instead?

Use a URL with tag name instead of "latest", like

https://github.com/loongson/LoongArch-Documentation/releases/download/2022.08.12/LoongArch-Vol1-v1.02-CN.pdf

It will still refer to an outdated doc if the doc is updated, but at
least it won't be broken.
  
Huacai Chen Dec. 4, 2022, 8:32 a.m. UTC | #3
For the whole series,
Acked-by: Huacai Chen <chenhuacai@loongson.cn>

On Thu, Dec 1, 2022 at 6:59 PM Tiezhu Yang <yangtiezhu@loongson.cn> wrote:
>
> Tiezhu Yang (2):
>   docs/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
>   docs/zh_CN/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
>
>  Documentation/loongarch/introduction.rst                    | 8 ++++----
>  Documentation/translations/zh_CN/loongarch/introduction.rst | 8 ++++----
>  2 files changed, 8 insertions(+), 8 deletions(-)
>
> --
> 2.1.0
>
  
Tiezhu Yang Dec. 5, 2022, 1:44 a.m. UTC | #4
On 12/03/2022 06:58 PM, Jonathan Corbet wrote:
> Tiezhu Yang <yangtiezhu@loongson.cn> writes:
>
>> Tiezhu Yang (2):
>>   docs/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
>>   docs/zh_CN/LoongArch: Update links of LoongArch ISA Vol1 and ELF psABI
>>
>>  Documentation/loongarch/introduction.rst                    | 8 ++++----
>>  Documentation/translations/zh_CN/loongarch/introduction.rst | 8 ++++----
>>  2 files changed, 8 insertions(+), 8 deletions(-)
>
> I've applied these - working links are better than broken ones.  I
> assume, though, that the new URLs, too, will break the next time the
> manual is updated?  Is there any chance Loongson could provide a stable
> URL for the current version of this manual instead?
>
> Thanks,
>
> jon
>

Here are my thoughts:

(1) Just use the release link without file name, simple and timeless.

https://github.com/loongson/LoongArch-Documentation/releases

(2) Use the online html links, but the Chinese html version of ISA
Vol1 is unavailable now.

https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol1-CN.html 
(unavailable now)
https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol1-EN.html

https://loongson.github.io/LoongArch-Documentation/LoongArch-ELF-ABI-CN.html
https://loongson.github.io/LoongArch-Documentation/LoongArch-ELF-ABI-EN.html

(3) As Ruoyao said, use a link with tag name instead of "latest",
may be outdated but always valid.

https://github.com/loongson/LoongArch-Documentation/releases/download/2022.08.12/LoongArch-Vol1-v1.02-CN.pdf

Thanks,
Tiezhu