git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] git-reflog.txt: add an EXAMPLES section

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 3, 2022, 16:36 UTC
Message-ID
<xmqq4jwkx3st.fsf@gitster.g>
In-Reply-To
<da2c8d2f-eefa-1681-b1f2-93c7865c300c@gmail.com>
Bagas Sanjaya <bagasdotme@gmail.com> writes:
Show 9 quoted lines
> On 10/3/22 15:46, Elia Pinto wrote:
>> This commit adds an "EXAMPLES" section to the git reflog man page.
>> This new section currently provides examples of using git reflog
>> with branches, for which doubts often exist. In this commit we also
>> add a "SEE ALSO" section which refers to further information
>> on git commands or documentation referenced in the git reflog man page.
>> 
>
> Better say "Add git-reflog usage examples to the man page."
Thanks, indeed.
> Also, shouldn't "SEE ALSO" additions be split from this patch?

I think they are better together. The overall theme is to help readers of that one documentation page, and 80% of the effort of this step is spent on adding an EXAMPLES section, while the rest goes to SEE ALSO.

Thanks.
Previous: Bagas Sanjaya
Message 7 of 7 in “git-reflog.txt: add an EXAMPLES section”
  1. git-reflog.txt: add an EXAMPLES sectionElia Pinto, Oct 3, 2022
  2. Ævar Arnfjörð BjarmasonOct 3, 2022
  3. Elia PintoOct 3, 2022
  4. Junio C HamanoOct 3, 2022
  5. Junio C HamanoOct 3, 2022
  6. Bagas SanjayaOct 3, 2022
  7. Junio C HamanoOct 3, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.