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

Re: [RFE] Demilitarize Documentation (was RE: Delivery Status Notification (Failure))

From
Michal Suchánek <msuchanek@suse.de>
Date
Feb 19, 2019, 13:58 UTC
Message-ID
<20190219145835.3cc1e545@kitsune.suse.cz>
In-Reply-To
<CAP8UFD0WCmPSb1ccj+yRVEMC8T9oFbznJ6PPuOhGC-BCru6uAg@mail.gmail.com>

On Tue, 19 Feb 2019 14:52:40 +0100 Christian Couder <christian.couder@gmail.com> wrote:

Show 47 quoted lines
> On Tue, Feb 19, 2019 at 12:23 PM Ævar Arnfjörð Bjarmason
> <avarab@gmail.com> wrote:
> >
> > Two things:
> >
> >  1) Whatever anyone's abstract position on the wording of our
> >     documentation, either the one stored in git.git or at
> >     https://github.com/git/git-scm.com there's only so much a
> >     theoretical discussion like this can get us.
> >
> >     If you're willing to pursue this further I think it's best if that's
> >     done in the form of patches to either repositories, either sent here
> >     on-list (see Documentation/SubmittingPatches) or as a PR to
> >     https://github.com/git/git-scm.com  
> 
> I agree.
> 
> >  2) Any piece of software or technical tool is going to unavoidably need
> >     to use some amount of jargon, or words that are lifted from a more
> >     general vocabulary and intended to be understood in context.
> >
> >     Thus, when we talk about e.g. "trees" in git, it's understood that
> >     we're talking about something in the context of this software
> >     project, trying to go by the first Google result of "tree" isn't
> >     going to get you anywhere.
> >
> > I for one thing those git-scm docs could be changed to eliminate those
> > words for reasons entirely unrelated to them somehow being religious or
> > militaristic.  
> 
> I agree that it would be a much better outcome of this discussion.
> 
> >  * The docs already use "integration manager" and then introduce
> >    "dictator" as a synonym in the context of explaining the workflow of
> >    the kernel.
> >
> >    They could instead use "main integrator" or something, since the
> >    point of the example is to explain how git can be used to manage
> >    distributed repositories that are integrated in a hierarchical
> >    manner.  
> 
> I would suggest considering "maintainer" or "main maintainer" or "top
> level maintainer", as I think "maintainer" is one of the most common
> word used for the role in the Linux kernel and Git communities. By the
> way it's often used in expressions like "sub-system maintainer", which
> maybe could be used to replace "lieutenant".
> 

Which suggests certain way the responsibility is divided in the project and limits the thinking of the people reading the documentations.

While for many projects it is sensible to divide the project into subsystems and have subsystem maintainers for some it is not and they need different way to divide the work.

For some projects the role of maintainer and integrator is fulfilled by the same person and for some it might be not.

Thanks
Michal
Previous: Christian Couder
Message 18 of 18 in “Re: [RFE] Demilitarize Documentation (was RE: Delivery Status Notification (Failure))”
  1. Randall S. BeckerFeb 18, 2019
  2. Michal SuchánekFeb 18, 2019
  3. Junio C HamanoFeb 18, 2019
  4. Senol YaziciFeb 19, 2019
  5. Michal SuchánekFeb 19, 2019
  6. Johannes SchindelinFeb 19, 2019
  7. Michal SuchánekFeb 19, 2019
  8. SZEDER GáborFeb 19, 2019
  9. Senol YaziciFeb 19, 2019
  10. Johannes SchindelinFeb 19, 2019
  11. Michal SuchánekFeb 19, 2019
  12. Johannes SchindelinFeb 20, 2019
  13. Philip OakleyFeb 19, 2019
  14. SZEDER GáborFeb 20, 2019
  15. Ævar Arnfjörð BjarmasonFeb 19, 2019
  16. Michal SuchánekFeb 19, 2019
  17. Christian CouderFeb 19, 2019
  18. Michal SuchánekFeb 19, 2019

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.