[Forgot to attach my diff in the previous message, sorry for the noise.] [Following the thread in order to keep this talk in the archives.]
Le 19/06/2010 12:14, Osamu Aoki a écrit : >> - <p>As you may have noticed, Debian is divided in sections: <tt>main</tt> >> (the free >> + <p>You can use one of the three following sections: <tt>main</tt> (the >> free > I am intentially neutral here based on voting record. I will not do > this. Thanks, just adding "archive" is better than my awful long patch, and it's accurate. >> @@ -2085,7 +2089,7 @@ >> >> <p>If you don't need these, remove them. >> >> - <sect id="examples"><file><var>package</var>.examples</file> file >> + <sect id="examples"><file><var>package</var>.examples</file> files > > This ends with s but this could be a file. Sure, I just wanted to provide a consistent title with package.info and package.manpages, adjusted on the other way in the current patch. >> - <file>etc/default/<var>package</var></file>. This file >> + <file>/etc/default/<var>package</var></file>. This file > > Thanks but this is intentional. This is under ./debian . Sure, thus correcting <file>etc/init.d/<var>package</var></file> on the previous paragraph, included in the current patch (hope this is correct). >> <sect id="manpage"><file>manpage.*</file> files >> >> - <p>Your program(s) should have a manual page. If they don't, you must >> create >> + <p>Your program(s) should have a manual page. If they don't, you should >> create > > These uses of "shoud" and "must" are my intentional choice as tutorial. As you wish, but a manpage is not (and can't be) a "must", since some programs are not intended to be shell executable: some CMS like phpbb3 have no use of a manpage, even if some documentation is shipped in the package under another form, and the same remark is applicable to the package main-guide... (It's kept in the current patch, but I won't upload it if you are not agree, of course). >> - <p>For <ref id="first">, we created 3 patches in >> <file>debian/patches</file>. >> + <p>For <ref id="modify">, we created 3 patches in >> <file>debian/patches</file>. > > Why? (I am tired good night. ) The three patches are created in chapter 3 "Modifying the source" (id="modify"), not in chapter 2 "First steps" (id="first"). The last diff of the current patch contains, in top of the nip ticking "debianize" change a s/it/them/ at the end of the line (because I assume we are talking about the added files, not directory to be edited). I also included a patch to remove jargon neologism "debianize" as it should be done next week in the Policy, cf. #586163 (I intend to propose to do the same for the developers-reference). Is it OK with you if I try and fix s/section/area/ to conform with Policy (and DFSG) about what {main|contrib|non-free} are (I intend to propose to do the same for the developers-reference) ? Cheers David
--- . (révision 7417) +++ . (copie de travail) @@ -640,7 +640,7 @@ should contact the upstream maintainer to see if they've got some other revision-tracking method. - <sect id="dh_make">Initial <em>debianization</em> + <sect id="dh_make">Initial Debian package <p>Let's set up the Bash shell environment variable <tt>$DEBEMAIL</tt> and <tt>$DEBFULLNAME</tt> so many Debian maintenance tools recognize your name and @@ -654,7 +654,7 @@ EOF </example> - <p>Let's make initial <em>debianization</em> by issuing the <prgn>dh_make</prgn> command as follows. + <p>Let's make an initial Debian package by issuing the <prgn>dh_make</prgn> command as follows. <example> $ . ~/.bashrc @@ -731,8 +731,8 @@ <p>If you accidentally erased some template files while working on them, you can recover them by running <prgn>dh_make</prgn> with the - <tt>--addmissing</tt> option again in an already <em>debianized</em> - directory. + <tt>--addmissing</tt> option again in a Debian package + source tree. <p>Updating an existing package may get complicated since it may be using older techniques. Please stick with fresh packaging cases for now to learn @@ -1927,7 +1927,7 @@ <sect id="readme"><file>README.Debian</file> file <p>Any extra details or discrepancies between the original package and - your <em>debianized</em> version should be documented here. + your Debian version should be documented here. <p><prgn>dh_make</prgn> created a default one, this is what it looks like: @@ -2095,7 +2095,7 @@ you've obviously disregarded my initial recommendation, haven't you? :-) <p>The <file><var>package</var>.init</file> file is installed as the - <file>/etc/init.d/<var>package</var></file> script. Its fairly generic + <file>etc/init.d/<var>package</var></file> script. Its fairly generic skeleton template is provided by the <prgn>dh_make</prgn> command as <file>init.d.ex</file>. You'll likely have to rename and edit it, a lot, while making sure to provide Filesystem Hierarchy Standard @@ -2156,7 +2156,7 @@ <file>debian/tmp</file> for files, if it doesn't find them in the current directory (or wherever you've told it to look using <tt>--sourcedir</tt>). - <sect id="info"><file><var>package</var>.info</file> files + <sect id="info"><file><var>package</var>.info</file> file <p>If your package has info pages, you should install them using <manref name="dh_installinfo" section="1"> by listing them in the @@ -2181,7 +2181,7 @@ <sect id="manpage"><file>manpage.*</file> files - <p>Your program(s) should have a manual page. If they don't, you must create + <p>Your program(s) should have a manual page. If they don't, you should create them. The <prgn>dh_make</prgn> command creates few template files for a manual page. These need to be copied and edited for each command without its manual page. Please make sure to remove unused templates. @@ -2246,7 +2246,7 @@ <sect1 id="manpagexml"><file>manpage.xml.ex</file> file <p>If you prefer XML over SGML, you can use the <tt/manpage.xml.ex/ template. - If you do this, you have two choices: + If you do this, you have to: <list> <item>rename the source file to something like <tt/gentoo.1.xml/ @@ -2268,7 +2268,7 @@ </example> </list> - <sect id="manpages"><file><var>package</var>.manpages</file> files + <sect id="manpages"><file><var>package</var>.manpages</file> file <p>If your package has manual pages, you should install them using <manref name="dh_installman" section="1"> by listing them in the @@ -2471,7 +2471,7 @@ clear separation and documentation of your changes are very important to expedite the package review by your sponsor.</footnote> - <p>For <ref id="first">, we created 3 patches in <file>debian/patches</file>. + <p>For <ref id="modify">, we created 3 patches in <file>debian/patches</file>. <p>Since Debian patches are located in <file>debian/patches</file>, please make sure to setup the <prgn>quilt</prgn> command properly as described @@ -3261,8 +3261,8 @@ <list> <item>If you need to add erased template files for any reason, you may run - <prgn>dh_make</prgn> again in the same, already <em>debianized</em>, - directory with <tt>--addmissing</tt> option. Then edit it properly. + <prgn>dh_make</prgn> again in the same Debian package + source tree with <tt>--addmissing</tt> option. Then edit them properly. <item>If the package has not updated to use the <package>debhelper</package> V7 <prgn>dh</prgn> syntax for the <file>debian/rules</file> file, update it to
signature.asc
Description: OpenPGP digital signature