threads / discuss / 32479

patch, 3 partsAw: Re: [PATCH 0/3] Move CodingGuidelines and SubmittingPatches to ./Documentation/technical

Subject: Aw: Re: [PATCH 0/3] Move CodingGuidelines and SubmittingPatches to ./Documentation/technical

## tl;dr

3 messages between Dec 30, 2012 and Dec 31, 2012. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Thomas Ackermann· Dec 30, 2012, 14:56 UTC · lore

 
./Documentation/technical contains not only API documentation but also
several other documents describing Git implementation topics and thus
is the place someone wanting to join Git development should look at.
So IMHO CodingGuidelines and SubmittingPatches should also be there.
(One could even consider renaming ./technical to ./internal to stress this point
and get rid of the rather generic "technical" ...)

In contrast ./howto implies containing documents a Git *user* might need to solve some tricky problems (and to this end maintain-git.txt and new-command.txt should also be moved to ./technical (sorry for being the guy who just moved ./technical/api-command to ./howto/new-command.txt ;-)).

./Documentation itself should only contain the command manpages and tutorials.

----- Original Nachricht ----
Von:     Ramkumar Ramachandra <artagnon@gmail.com>
An:      Thomas Ackermann <th.acker@arcor.de>
Datum:   30.12.2012 12:52
Betreff: Re: [PATCH 0/3] Move CodingGuidelines and SubmittingPatches to ./Documentation/technical

Show 14 quoted lines

> Thomas Ackermann wrote:
> > CodingGuidelines and SubmittingPatches are IMHO a little bit hidden in
> ./Documentation
> > and with respect to their content should be better placed in
> ./Documentation/technical.
> 
> I don't think SubmittingPatches and CodingGuidelines belong to
> Documentation/technical; that location is mostly reserved for API
> documentation.  Also, being prominent documents, they're probably
> linked to by many places on the internet.  I wouldn't want to
> unnecessarily break those links.
> 
> Ram
>

--- Thomas

Junio C Hamano· Dec 30, 2012, 21:40 UTC · re: Thomas Ackermann · lore

Re: Aw: Re: [PATCH 0/3] Move CodingGuidelines and SubmittingPatches to ./Documentation/technical

Thomas Ackermann <th.acker@arcor.de> writes:

>  
> ./Documentation/technical contains not only API documentation but also
> several other documents describing Git implementation topics and thus
> is the place someone wanting to join Git development should look at.

Implementation details are part of API; CG and SP are social not technical.

Also CG and SP are in the part of the documents that are not installed for end-users and that is their right place. They matter only to the people who grab our source code.

Thomas Ackermann· Dec 31, 2012, 09:33 UTC · re: Junio C Hamano · lore

Aw: Re: Aw: Re: [PATCH 0/3] Move CodingGuidelines and SubmittingPatches to ./Documentation/technical

> 
> Implementation details are part of API; CG and SP are social not
> technical.
>

This depends on your definition of "social" ;-)

Show 5 quoted lines

> 
> Also CG and SP are in the part of the documents that are not
> installed for end-users and that is their right place.  They matter
> only to the people who grab our source code.
>

But isn't that true for all files in ./technical? CG and SP currently are in ./Documentation which contains *only* files which are installed for end-users with CG and SP the only exception ...

--- Thomas