Skip to content

RFC various documentation bits

Kenneth Lorber git 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest6 patches 15 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/6Tell the glossary about core.hooksPathDocumentation/glossary-content.txt+6 -42 replies
2/6Add bit on extending git to Hacking GitDocumentation/user-manual.txt+8 -02 replies
3/6Add namespace collision avoidance guidelines fileDocumentation/gitrepository-layout.txt Documentation/technical/namespace-collisions.txt+87 -04 replies
4/6Include NAMESPACE COLLISIONS doc into gitrepository-layout.txtDocumentation/gitrepository-layout.txt+2 -12 replies
5/6Tell config.txt about NAMESPACE COLLISIONSDocumentation/config.txt+3 -11 reply
6/6Add NAMESPACE COLLISIONS reference to Hacking GitDocumentation/user-manual.txt+1 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [RFC PATCH 0/6] various documentation bits

From: Kenneth Lorber <[email protected]>

This started as an effort to understand this section of config.txt:
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.
and grew from there.

I don't expect this to be adopted as is, but I've found it much easier to discuss something concrete rather than an abstract "this is incomplete" or "this is hard to find."

Cut from master.

keni (6):
Tell the glossary about core.hooksPath
Add bit on extending git to Hacking Git
Add namespace collision avoidance guidelines file Include NAMESPACE COLLISIONS doc into gitrepository-layout.txt Tell config.txt about NAMESPACE COLLISIONS
Add NAMESPACE COLLISIONS reference to Hacking Git

 Documentation/config.txt                      |  4 +-
 Documentation/gitrepository-layout.txt        |  2 +
 Documentation/glossary-content.txt            | 10 ++-
 .../technical/namespace-collisions.txt        | 86 +++++++++++++++++++
 Documentation/user-manual.txt                 |  9 ++
 5 files changed, 106 insertions(+), 5 deletions(-)
 create mode 100644 Documentation/technical/namespace-collisions.txt
Signature · 1 line
2.17.1