Re: Git commands version documentation

[Philip Oakley <philipoakley@iee.email>]

Hi Junio,

On 23/05/2022 00:35, Junio C Hamano wrote:
> Philip Oakley <philipoakley@iee.email> writes:
>
>> One manual method is to look at the history (blame) for the respective
>> man pages to see when the man page was initially committed, and when
>> appropriate options were added.
>>
>> Maybe use one of the hosting providers GUI if that is your choice e.g.
>> https://github.com/git/git/blame/master/Documentation/git-gc.txt
> I got an impression that blame/log is an overkill for the request,
> which asks for "what tagged version?", to which the answer would be
> to compare the manual pages for each release (or scan the release
> notes), perhaps?
>
>

I was also concerned as to which way the problem was being addressed: 
was it a need for a cross reference table for all commands, or was it 
for just a select few?

For me, who likes a good UI, I found the GitHub blame UI quite useful 
when looking at files from the latter direction. It was much easier to 
scan the blame for the command's documentation page than try and scan 
through the endless release notes. Obviously this does expect that our 
documentation is fairly complete, at least at the 'mention an option' 
level, even if the occasional nuance didn't reach the docs.


I can see that a cli terminal representation is likely to be harder to 
scan, and that some hosters don't provide a blame page, so it would be a 
'horses for courses' choice.

Philip