diff mbox series

reftable: technical documentation link fixes

Message ID 20200525210232.87550-1-carenas@gmail.com
State New, archived
Headers show
Series reftable: technical documentation link fixes | expand

Commit Message

Carlo Arenas May 25, 2020, 9:02 p.m. UTC
Showing as broken links in the html version (when using asciidoc 8.6.10)
because some of the characters in the url need encoding.

Change them to use a explicit "link" and URL encode the problematic
charecters (ex: +, =, @).  While at it, change the base URL to use
lore.kernel.org as has been suggested since 56e6c16394 (Merge branch
'dl/lore-is-the-archive', 2019-12-06)

Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com>
---
 Documentation/technical/reftable.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Carlo Arenas May 25, 2020, 10 p.m. UTC | #1
Forgot to mention, the third URL wasn't updated since it was somehow not
affected, while the first one wasn't affected when using Asciidoctor 2.0.10.

The middle one always breaks (even with Asciidoctor) because of the "="
character, so the "minimal" change needed will be to URL encode that as %3D
or use "link" as proposed in the patch.

Carlo
Han-Wen Nienhuys May 26, 2020, 6:53 p.m. UTC | #2
On Mon, May 25, 2020 at 11:03 PM Carlo Marcelo Arenas Belón
<carenas@gmail.com> wrote:
>
> Showing as broken links in the html version (when using asciidoc 8.6.10)
> because some of the characters in the url need encoding.
>

Thanks, looks good to me.

What do I do now? Does Junio fold this in, or do I have to send an
updated patch series?
Carlo Arenas May 26, 2020, 11:16 p.m. UTC | #3
On Tue, May 26, 2020 at 08:53:08PM +0200, Han-Wen Nienhuys wrote:
> 
> What do I do now? Does Junio fold this in, or do I have to send an
> updated patch series?

since the issue was introduced with 27eede2922 (reftable: file format
documentation, 2020-05-20) which is already in next, then Junio might
just add it to the tip of either hn/reftable or hn/refs-cleanup and
include it with the reroll that would come after the 2.27 release.

if you have other fixes and are planning a reroll on those branches
then it might be better if you squash it in and therefore avoid both
the bug and my typo in the commit message.

Carlo
Jonathan Nieder May 27, 2020, 2:21 a.m. UTC | #4
Carlo Marcelo Arenas Belón wrote:

> Subject: reftable: technical documentation link fixes

For next time, try to make the subject line summarize what specific
improvement the patch makes.  For example:

	reftable doc: use link: and urlencode to avoid dead links

> Showing as broken links in the html version (when using asciidoc 8.6.10)
> because some of the characters in the url need encoding.
>
> Change them to use a explicit "link" and URL encode the problematic
> charecters (ex: +, =, @).  While at it, change the base URL to use
> lore.kernel.org as has been suggested since 56e6c16394 (Merge branch
> 'dl/lore-is-the-archive', 2019-12-06)
>
> Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com>
> ---
>  Documentation/technical/reftable.txt | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Thanks.
Junio C Hamano May 27, 2020, 5:14 p.m. UTC | #5
Jonathan Nieder <jrnieder@gmail.com> writes:

> Carlo Marcelo Arenas Belón wrote:
>
>> Subject: reftable: technical documentation link fixes
>
> For next time, try to make the subject line summarize what specific
> improvement the patch makes.  For example:
>
> 	reftable doc: use link: and urlencode to avoid dead links
>
>> Showing as broken links in the html version (when using asciidoc 8.6.10)
>> because some of the characters in the url need encoding.
>>
>> Change them to use a explicit "link" and URL encode the problematic
>> charecters (ex: +, =, @).  While at it, change the base URL to use
>> lore.kernel.org as has been suggested since 56e6c16394 (Merge branch
>> 'dl/lore-is-the-archive', 2019-12-06)
>>
>> Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com>
>> ---
>>  Documentation/technical/reftable.txt | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Will queue at the tip of hn/reftable for now, but post 2.27-final,
we should tentatively eject hn/refs-cleanup out of 'next' and squash
this fix in to the step that originally introduced the problem (and
of course, new version of hn/reftable need to be based on the updated
hn/refs-cleanup topic when it happens).

Thanks, both.
diff mbox series

Patch

diff --git a/Documentation/technical/reftable.txt b/Documentation/technical/reftable.txt
index 6eae449685..2951840e9c 100644
--- a/Documentation/technical/reftable.txt
+++ b/Documentation/technical/reftable.txt
@@ -1028,7 +1028,7 @@  Michael Haggerty's alternate format
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Michael Haggerty proposed
-https://public-inbox.org/git/CAMy9T_HCnyc1g8XWOOWhe7nN0aEFyyBskV2aOMb_fe+wGvEJ7A@mail.gmail.com/[an
+link:https://lore.kernel.org/git/CAMy9T_HCnyc1g8XWOOWhe7nN0aEFyyBskV2aOMb_fe%2BwGvEJ7A%40mail.gmail.com/[an
 alternate] format to reftable on the Git mailing list. This format uses
 smaller chunks, without the restart table, and avoids block alignment
 with padding. Reflog entries immediately follow each ref, and are thus
@@ -1050,7 +1050,7 @@  JGit Ketch RefTree
 
 https://dev.eclipse.org/mhonarc/lists/jgit-dev/msg03073.html[JGit Ketch]
 proposed
-https://public-inbox.org/git/CAJo=hJvnAPNAdDcAAwAvU9C4RVeQdoS3Ev9WTguHx4fD0V_nOg@mail.gmail.com/[RefTree],
+link:https://lore.kernel.org/git/CAJo%3DhJvnAPNAdDcAAwAvU9C4RVeQdoS3Ev9WTguHx4fD0V_nOg%40mail.gmail.com/[RefTree],
 an encoding of references inside Git tree objects stored as part of the
 repository's object database.
 
@@ -1070,7 +1070,7 @@  LMDB
 ^^^^
 
 David Turner proposed
-https://public-inbox.org/git/1455772670-21142-26-git-send-email-dturner@twopensource.com/[using
+https://lore.kernel.org/git/1455772670-21142-26-git-send-email-dturner@twopensource.com/[using
 LMDB], as LMDB is lightweight (64k of runtime code) and GPL-compatible
 license.