Re: Git documentation writing guidelines

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

 



Jakub Narebski <jnareb@xxxxxxxxx> writes:

> Junio C Hamano <gitster@xxxxxxxxx> writes:
>
>> Jeff King <peff@xxxxxxxx> writes:
>
>> > git-config (or perhaps even gitconfig(7)) should have a list of all
>> > variables and where they are described, like:
>> >
>> >   apply.ignorewhitespace        git-apply(1)
>> >   apply.whitespace              git-apply(1)
>> >   branch.autosetupmerge         git-branch(1)
>> >   [etc]
>> >
>> > There is not much point in having full descriptions in one giant list.
>> > Instead, you can peruse the whole list, and then go to the configuration
>> > section of the relevant manpage to see a bunch of related options. Such
>> > a list should be pretty easy to generate automatically from the other
>> > documentation.
>> 
>> Yes, I like it.
>
> Well, there are some variables, like advice.*, or core.*, or alias.*, or
> color.*, or browser.<tool>.path, or i18n.*, or interactive.singlekey,
> or notes.*, or user.* that do not really belong to single git command
> (well, perhaps they could be put in git(1) manpage), or belong to more
> than one command.

So?

Naturally they will be listed like:

    alias.*		git(1)
    color.diff.*	git-diff(1)
    browser.*.path      git(1)
    ...

and I don't see a problem in the general structure Jeff suggested.

    
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[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]