Re: [PATCH] doc: git-add.txt: convert to new style convention

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Le 12/11/2024 à 01:38, Junio C Hamano a écrit :
> "Jean-Noël Avila via GitGitGadget" <gitgitgadget@xxxxxxxxx> writes:
> 
>> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@xxxxxxx>
>>
>> Signed-off-by: Jean-Noël Avila <jn.avila@xxxxxxx>
>> ---
>>     doc: git-add.txt: convert to new style convention
> 
> This does slightly more than converting to new style, though,
> doesn't it?  Is it so annoying to see a link that points at the same
> page you are reading right now to warrant duplicating some docs with
> conditional inclusion?
> 
>> +`add.ignoreErrors`::
>> +`add.ignore-errors` (deprecated)::
>> +	Tells `git add` to continue adding files when some files cannot be
>> +	added due to indexing errors.
>> +ifdef::git-add[]
>> +	Equivalent to the `--ignore-errors` option.
>> +endif::git-add[]
>> +ifndef::git-add[]
>> +	Equivalent to the `--ignore-errors` option of linkgit:git-add[1].
>> +endif::git-add[]
> 

This was already performed for git-clone (ebb55042a4) and git-init
(e7b3a7683c). Should it be separated in a dedicated commit?


If the link is not to a specific anchor in the doc (which is the aim in
html output), it is considered bad practice (against the "Make your
visitor confident that the link they're following will take them where
they want to go" principle). To create a sensible link, we would have to
bring the visitor to the corresponding option description. This is
doable, but would require an enhanced linkgit macro and additional anchors.


begin:vcard
fn;quoted-printable:Jean-No=C3=ABl Avila
n;quoted-printable:Avila;Jean-No=C3=ABl
org:Scantech S.A.
adr;quoted-printable:Savoie Technolac BP 244;;B=C3=A2timent Androm=C3=A8de - 108 Avenue du Lac L=C3=A9man ; LA MOTTE SERVOLEX;;73290;France
email;internet:jean-noel.avila@xxxxxxxxxxxx
title:Embedded systems manager
tel;work:+33 479 25 54 50
tel;cell:+33 633 04 64 18
x-mozilla-html:FALSE
url:http://www.scantech.com
version:2.1
end:vcard


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux