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

Re: [RFC PATCH 5/6] Tell config.txt about NAMESPACE COLLISIONS

From
Junio C Hamano <gitster@pobox.com>
Date
May 18, 2020, 00:32 UTC
Message-ID
<xmqqmu665bha.fsf@gitster.c.googlers.com>
In-Reply-To
<1589681624-36969-6-git-send-email-keni@hers.com>
Kenneth Lorber <keni@hers.com> writes:
Show 22 quoted lines
> From: Kenneth Lorber <keni@his.com>
>
> Add a link to the NAMESPACE COLLISIONS information where git help config
> only mentioned the issue without supplying any guidance for how to do that.
>
> Signed-off-by: Kenneth Lorber <keni@his.com>
> ---
>  Documentation/config.txt | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index ef0768b91a..1e819c26f0 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -310,7 +310,9 @@ in the appropriate manual page.
>  Other git-related tools may and do use their own variables.  When
>  inventing new variables for use in your own tool, make sure their
>  names do not conflict with those that are used by Git itself and
> -other popular tools, and describe them in your documentation.
> +other popular tools, and describe them in your documentation.  See
> +'NAMESPACE COLLISIONS' in linkgit:gitrepository-layout[5] for guidelines
> +to prevent such conflicts.

The configuration variable namespace is a shared resource, and it does make sense to give a provision for third-party tools to coordinate to avoid stepping on each others' toes.

The repository-layout document is about a physical on-filesystem structure that ought to be blackbox to third-party tools, so the link target may have to be different from what this patch wants to add, though.

I'd rather not to have such a document prematurely; if we were to add something to this paragraph (and I do think it is a good idea to say a bit more than "you're on your own but make sure you do not conflict with Git and other people" which is what we have there in the original), I'd just stop at telling readers to come here to the list to discuss and solicit input from other Git stakeholders.

Thanks.
Previous: Kenneth LorberNext: Kenneth Lorber
Message 9 of 42 in “various documentation bits”
  1. 0/6 various documentation bitsKenneth Lorber, May 17, 2020
  2. 2/6 Add bit on extending git to Hacking GitKenneth Lorber, May 17, 2020
  3. Junio C HamanoMay 17, 2020
  4. Kenneth LorberMay 18, 2020
  5. 1/6 Tell the glossary about core.hooksPathKenneth Lorber, May 17, 2020
  6. Junio C HamanoMay 17, 2020
  7. Kenneth LorberMay 18, 2020
  8. 5/6 Tell config.txt about NAMESPACE COLLISIONSKenneth Lorber, May 17, 2020
  9. Junio C HamanoMay 18, 2020
  10. 4/6 Include NAMESPACE COLLISIONS doc into gitrepository-layout.txtKenneth Lorber, May 17, 2020
  11. Junio C HamanoMay 18, 2020
  12. Kenneth LorberMay 18, 2020
  13. 3/6 Add namespace collision avoidance guidelines fileKenneth Lorber, May 17, 2020
  14. Abhishek KumarMay 17, 2020
  15. Kenneth LorberMay 18, 2020
  16. Junio C HamanoMay 17, 2020
  17. Kenneth LorberMay 18, 2020
  18. 6/6 Add NAMESPACE COLLISIONS reference to Hacking GitKenneth Lorber, May 17, 2020
  19. Abhishek KumarMay 17, 2020
  20. Junio C HamanoMay 17, 2020
  21. Kenneth LorberMay 18, 2020
  22. Kenneth LorberMay 18, 2020
  23. 0/6 various documentation bitsKenneth Lorber, May 25, 2020
  24. 6/6 doc: Add collision reference to Hacking GitKenneth Lorber, May 25, 2020
  25. 2/6 doc: Add bit on extending git to Hacking GitKenneth Lorber, May 25, 2020
  26. 3/6 doc: Add namespace collision guidelines fileKenneth Lorber, May 25, 2020
  27. Junio C HamanoMay 28, 2020
  28. Junio C HamanoMay 28, 2020
  29. Junio C HamanoMay 29, 2020
  30. Junio C HamanoMay 29, 2020
  31. Kenneth LorberJun 1, 2020
  32. Kenneth LorberJun 1, 2020
  33. 4/6 doc: Add collision doc to gitrepository-layout.txtKenneth Lorber, May 25, 2020
  34. 1/6 doc: Tell the glossary about core.hooksPathKenneth Lorber, May 25, 2020
  35. Junio C HamanoMay 26, 2020
  36. Kenneth LorberMay 27, 2020
  37. Kenneth LorberMay 27, 2020
  38. Junio C HamanoMay 27, 2020
  39. 5/6 doc: Tell config.txt about namespace collisionsKenneth Lorber, May 25, 2020
  40. 0/2 update glossary hooks entryKenneth Lorber, May 31, 2020
  41. 1/2 doc: Tell the glossary about core.hooksPathKenneth Lorber, May 31, 2020
  42. 2/2 doc: remove dated info and refs to sample hooksKenneth Lorber, May 31, 2020

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.