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

2012-12-31 Thread Thomas Ackermann
 
 
 Implementation details are part of API; CG and SP are social not
 technical.
 
This depends on your definition of social ;-)
 
 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
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


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

2012-12-30 Thread Thomas Ackermann

CodingGuidelines and SubmittingPatches are IMHO a little bit hidden in 
./Documentation
and with respect to their content should be better placed in 
./Documentation/technical.

[PATCH 1/3] Move CodingGuidelines to ./technical/coding-guidelines.txt and 
SubmittingPatches to ./technical/submitting-patches.txt
[PATCH 2/3] Add coding-guidelines.txt and submitting-patches.txt to 
./Documentation/Makefile
[PATCH 3/3] Convert coding-guidelines.txt and submitting-patches.txt to asciidoc


---
Thomas
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


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

2012-12-30 Thread Thomas Ackermann
 
./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 artag...@gmail.com
An:  Thomas Ackermann th.ac...@arcor.de
Datum:   30.12.2012 12:52
Betreff: Re: [PATCH 0/3] Move CodingGuidelines and SubmittingPatches to 
./Documentation/technical

 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
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


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

2012-12-30 Thread Junio C Hamano
Thomas Ackermann th.ac...@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.
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html