songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updates after the removal of changes.txt files.

This commit is contained in:
Sylvain Pion 2008-07-24 18:27:12 +00:00
parent 48b97a5e9b
commit ddbb01157f
3 changed files with 13 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Developers_manual/doc_tex/Developers_manual/directory_structure.tex
View File

@ -22,10 +22,10 @@ be included in an automated way into the internal (and public) releases of the
library, the files must be organized in a specific directory structure, which
we describe here. We describe the entire directory structure for a package.
Not every package will have all the parts described here. Only the files
{\tt maintainer}, {\tt changes.txt} and {\tt description.txt}
{\tt maintainer} and {\tt description.txt}
are obligatory.
\index{maintainer file@{\tt maintainer} file}
\ccIndexMainItem{\tt changes.txt}\ccIndexMainItem{\tt description.txt}
\ccIndexMainItem{\tt description.txt}
Submissions should not contain files in other places than described here.
Packages may be rejected if they do, and the contents won't go into releases.
@ -53,8 +53,6 @@ The directory structure of a package named Package should be as follows:
+--- developer_scripts/
|
+--- package_info/Package/
|
+- changes.txt
|
+- description.txt
|
@ -107,17 +105,6 @@ The directory structure of a package named Package should be as follows:
directory@{\tt developers\_scripts} directory} contains
scripts that are of interest to CGAL developers. This directory
is included in internal releases only, not in public releases.
\item[\ccAnchor{example/changes.txt}{{\tt changes.txt}}]%
\ccIndexMainItem{\tt changes.txt} used to document important
changes between subsequent versions. Each entry must provide the
date of the change and the name of the person who committed it, as
in the following example:
\begin{verse}
2 Feb 2004 Sylvain Pion\\
- Fix a memory-leak in file.h.\\
- Optimized function A::f().
\end{verse}
\item[{\tt description.txt}]%
\ccIndexMainItem{\tt description.txt}
should give a very short description of the contents of the package.

17
Developers_manual/doc_tex/Developers_manual/svn.tex
View File

@ -63,19 +63,25 @@ The repository tree has the following structure:
| |
| +--- Convex_hull_2/
| | |
| | |-- maintainer
| | |
| | |-- changes.txt
| | |
| | |-- TODO
| | |
| | +-- package_info/Convex_hull_2/
| | | |
| | | |-- maintainer
| | | |
| | | |-- description.txt
| | |
| | +-- include/CGAL/
| | |
| | +-- src/
| | |
| | +-- doc_tex/
| | |
| | +-- test/
| | +-- examples/Convex_hull_2/
| | |
| | +-- demo/Convex_hull_2/
| | |
| | +-- test/Convex_hull_2/
| | |
| | +-- ...
| |
@ -135,7 +141,6 @@ Here are the access rules:
{\texttt{Sylvain.Pion@sophia.inria.fr}} or
\ccAnchor{mailto:Laurent.Saboret@sophia.inria.fr}
{\texttt{Laurent.Saboret@sophia.inria.fr}}.
Also, indicate for which packages you need write permission.
\item
If your SSH key contains a passphrase, you have to enter it
in \texttt{ssh-agent}. Type: \\

1
Scripts/developer_scripts/list_package_files_impl.rb
View File

@ -20,7 +20,6 @@ def get_internal_package_files_list(package_dir)
'dont_submit',
'maintainer',
'description.txt',
'changes.txt',
'doc_tex',
'.svn'
]