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

Re: [PATCH v2 4/4] Documentation/git-status: mention how to detect copies

From
Elijah Newren <newren@gmail.com>
Date
Oct 6, 2021, 06:04 UTC
Message-ID
<CABPp-BHRw811_9M3hOEKUDVJkcY_BTYViH3ctsu6CDz9h-cCPQ@mail.gmail.com>
In-Reply-To
<88adcdf1-7b10-c834-84ad-52fe273c0ced@gmail.com>
On Tue, Oct 5, 2021 at 10:05 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
Show 32 quoted lines
>
> On 06/10/21 02.42, Johannes Altmanninger wrote:
> > I wasn't sure whether to add backticks to status.renames because we are
> > already inconsistent in this file (search for "config option").
> > Anyway I agree that backticks look better here (makes it bold in the man page).
> >
> > Maybe we should automate this? We can write a test that makes sure that we
> > always use backticks around config keys, at least for new changes.
> >
> > ---
> >
> > I didn't add backticks to "copies" to be consistent with this part before the context
> >
> >       Ignore changes to submodules when looking for changes. <when> can be
> >       either "none", "untracked", "dirty" or "all", which is the default.
> >
>
> I think for consistency, we can go with automated style changes that use
> backticks to monospace:
>      - file name and paths
>      - daemons/services
>      - configuration names and values
>      - file content (use ```...``` block unless inline)
>      - command-line
>      - keyboard keys (dunno?)
>      - any other inline text that needs to be written exactly
>
> I have seen many times articles that say `Run "foo bar" (no quotes)`
> when they mean `Run `foo bar``.
>
> For the exception you mentioned above it can be monospaced as part of
> automated change above.

Doing some cleanup passes on the documentation files would probably be a good thing, but it'd probably belong in a different series. Better to keep this one focused on the fixes being proposed.

Previous: Bagas SanjayaNext: Junio C Hamano
Message 13 of 16 in “Documentation/diff-format: state in which cases porcelain status is T”
  1. 1/2 Documentation/diff-format: state in which cases porcelain status is TJohannes Altmanninger, Oct 2, 2021
  2. 2/2 Documentation/git-status: document porcelain status T (typechange)Johannes Altmanninger, Oct 2, 2021
  3. Johannes AltmanningerOct 2, 2021
  4. Elijah NewrenOct 2, 2021
  5. Johannes AltmanningerOct 4, 2021
  6. 1/4 Documentation/git-status: remove impossible porcelain status DR and DCJohannes Altmanninger, Oct 4, 2021
  7. 2/4 Documentation/diff-format: state in which cases porcelain status is TJohannes Altmanninger, Oct 4, 2021
  8. 3/4 Documentation/git-status: document porcelain status T (typechange)Johannes Altmanninger, Oct 4, 2021
  9. 4/4 Documentation/git-status: mention how to detect copiesJohannes Altmanninger, Oct 4, 2021
  10. Bagas SanjayaOct 5, 2021
  11. Johannes AltmanningerOct 5, 2021
  12. Bagas SanjayaOct 6, 2021
  13. Elijah NewrenOct 6, 2021
  14. Junio C HamanoOct 4, 2021
  15. Junio C HamanoOct 4, 2021
  16. Elijah NewrenOct 2, 2021

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.