aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-29 11:17:31 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-29 11:17:31 +0000
commita4e09dccf5628a84a84c90868692b150ba9958b5 (patch)
tree6fcb89cae767d1b7c97f9e029b6a5ad520ca306b
parent60530c6b6a066814ba4d8cc46df11bc731a2faad (diff)
downloadpaludis-a4e09dccf5628a84a84c90868692b150ba9958b5.tar.gz
paludis-a4e09dccf5628a84a84c90868692b150ba9958b5.tar.xz
More docs updates
-rw-r--r--doc/doc_coding_standards.doxygen20
-rw-r--r--doc/doc_references.doxygen26
2 files changed, 33 insertions, 13 deletions
diff --git a/doc/doc_coding_standards.doxygen b/doc/doc_coding_standards.doxygen
index 944a9cb..058a561 100644
--- a/doc/doc_coding_standards.doxygen
+++ b/doc/doc_coding_standards.doxygen
@@ -7,6 +7,24 @@ These are rough guidelines. You should stick to these unless there's a good
reason to do otherwise. There are lots more standards that aren't documented
here yet -- ask for clarification as necessary.
+\section CodingStandardsCopyrights Copyrights and Licence
+
+Paludis is licenced under the GPLv2. Any contributions must use this licence.
+You should copy the standard licence header from another source file when
+creating new source files.
+
+Copyright is handled on a per-file basis. If you are the primary author of
+a file, you should list yourself as the copyright holder. If you make a
+substantial contribution to a source file (for example, one or more
+non-trivial classes, functions or methods), you should add yourself as a
+copyright holder on that file. You should <em>not</em> add to the copyright for
+small changes or bug fixes.
+
+Copyright years are per contributor. See, for example, paludis/fs_entry.hh for
+a file that has multiple copyright holders with different years.
+
+Substantial contributors should also list themselves in the AUTHORS file.
+
\section CodingStandardsIndentingAndSpacing Indenting and Spacing
Indents are four spaces. There are no tabs anywhere. Braces go on a line of
@@ -74,7 +92,7 @@ external are <code>_prefixed_with_underscore</code>.
Template values are <code>suffixed_with_underscore_</code>, and template
typenames are <code>SuffixedAsWell_</code> (and use <code>typename</code> rather
-than <code>class</code>).
+than <code>class</code>, \ref EffCpp item 42).
The files for <code>SomeClass</code> (and any small related utilities) would be
<code>some_class.hh</code> and <code>some_class.cc</code>. We are somewhat
diff --git a/doc/doc_references.doxygen b/doc/doc_references.doxygen
index 553af18..6cd4afa 100644
--- a/doc/doc_references.doxygen
+++ b/doc/doc_references.doxygen
@@ -3,29 +3,31 @@
/**
\page References References
-\paragraph EffCpp [EffC++]
-<strong>[EffC++]</strong> Effective C++ Third Edition / Scott Meyer /
+\section ReferencesBooks Books
+
+\anchor EffCpp
+<strong>EffCpp</strong>: Effective C++ Third Edition / Scott Meyer /
Addison-Wesley / ISBN 0-321-33487-6
-\paragraph EffSTL [EffSTL]
-<strong>[EffSTL]</strong> Effective STL / Scott Meyers / Addison-Wesley / ISBN
+\anchor EffSTL
+<strong>EffSTL</strong>: Effective STL / Scott Meyers / Addison-Wesley / ISBN
0-201-74962-9
-\paragraph GoF [GoF]
-<strong>[GoF]</strong> Design Patterns: Elements of Reusable Object-Oriented
+\anchor GoF
+<strong>GoF</strong>: Design Patterns: Elements of Reusable Object-Oriented
Software / Erich Gamma, Richard Helm, Ralph Johnson, John Vlissides /
Addison-Wesley / ISBN 0-201-63361-2
-\paragraph MCppD [MCppD]
-<strong>[MCppD]</strong> Modern C++ Design: Generic Programming and Design
+\anchor MCppD
+<strong>MCppD</strong>: Modern C++ Design: Generic Programming and Design
Patterns Applied / Andrei Alexandrescu / Addison-Wesley / ISBN 0-201-70431-5
-\paragraph TCppSL [TC++SL]
-<strong>[TC++SL]</strong> The C++ Standard Library / Nicolai M. Josuttis /
+\anchor TCppSL
+<strong>TCppSL</strong>: The C++ Standard Library / Nicolai M. Josuttis /
Addison-Wesley / ISBN 0-201-37926-0
-\paragraph TCppPL [TC++PL]
-<strong>[TC++PL]</strong> The C++ Programming Language Third Edition / Bjarne
+\anchor TCppPL
+<strong>TCppPL</strong>: The C++ Programming Language Third Edition / Bjarne
Stroustrup / Addison-Wesley / ISBN 0-201-88954-4
*/