mirror of https://github.com/tLDP/LDP
Merge branch 'master' of https://github.com/tLDP/LDP
This commit is contained in:
Martin A. Brown
commit
4b88f8fcbf
|
|
@ -263,46 +263,5 @@
|
|||
publication.
|
||||
</para>
|
||||
|
||||
<!--
|
||||
|
||||
<para> Once your LDP document has been carefully reviewed, you
|
||||
can release your document to the LDP. Send an e-mail with the
|
||||
source code as an attachment (you may gzip it if you like)
|
||||
to <email>submit@en.tldp.org</email>. </para>
|
||||
|
||||
<para> Be sure to include the name of your work in the subject
|
||||
line, and use the body to outline changes you've made and attach
|
||||
your document's source code. This allows the maintainers to do their jobs faster, and
|
||||
means your revised document will appear on the site faster.
|
||||
If you haven't heard anything in 5 calendar days,
|
||||
please follow up with an e-mail to make sure things are still in
|
||||
process. </para>
|
||||
|
||||
<para>If your text contains extras, such as graphics or a
|
||||
special catalog, create a .tar.gz file with all the files in it,
|
||||
including the XML source code, and mail it as an attachment to
|
||||
the submit list.</para>
|
||||
|
||||
<para>If you are using the LDP CVS tree while developing
|
||||
your document, the LDP will still need to be notified when your
|
||||
document is ready to be published. E-mail should be sent to
|
||||
<email>submit@en.tldp.org</email>. Indicate
|
||||
the title of your document and the relative path to the
|
||||
file(s) in the LDP CVS tree within your message. </para>
|
||||
|
||||
<para> To get a CVS account please refer to: <ulink
|
||||
url="http://tldp.org/cvs/">http://tldp.org/cvs/</ulink>
|
||||
</para>
|
||||
</section>
|
||||
<section id="compilations">
|
||||
<title>Publishing Compilations of LDP Documents</title>
|
||||
<para>
|
||||
If you are interested in publishing a collection of
|
||||
LDP documents, please visit <ulink
|
||||
url="http://www.tldp.org/manifesto.html#pub">http://www.tldp.org/manifesto.html#pub</ulink>
|
||||
for more information.
|
||||
</para>
|
||||
</section>
|
||||
-->
|
||||
</section>
|
||||
</chapter>
|
||||
|
|
|
|||
|
|
@ -85,7 +85,8 @@
|
|||
<listitem>
|
||||
<para>
|
||||
Once your document has been through each of the reviews a Review
|
||||
Coordinator will add it to the CVS, update the version number to 1.0
|
||||
Coordinator will approve addint it to the git repository, update the
|
||||
version number to 1.0
|
||||
and have the document published on the public Web site.
|
||||
For more information about your final submission to the LDP, please
|
||||
read <xref linkend="submission" />.
|
||||
|
|
|
|||
|
|
@ -1,64 +0,0 @@
|
|||
<!--
|
||||
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'>
|
||||
-->
|
||||
|
||||
<section id="submission">
|
||||
<title>Submission to LDP for publication</title>
|
||||
<note><title>The final step</title><para>
|
||||
This section contains information on what to do after your
|
||||
document has received both a technical and language review by the
|
||||
LDP volunteers.
|
||||
</para></note>
|
||||
|
||||
<para>
|
||||
As part of the review process a Review Coordinator will add your
|
||||
document to the git repository (including any associated image files) and
|
||||
notify the submit mailing list that your document is ready for
|
||||
publication.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Subsequent updates to your document can be made via git if you like. Please read
|
||||
<xref linkend="git" /> for more information.
|
||||
</para>
|
||||
<!--
|
||||
|
||||
<para> Once your LDP document has been carefully reviewed, you
|
||||
can release your document to the LDP. Send an e-mail with the
|
||||
source code as an attachment (you may gzip it if you like)
|
||||
to <email>submit@en.tldp.org</email>. </para>
|
||||
|
||||
<para> Be sure to include the name of your work in the subject
|
||||
line, and use the body to outline changes you've made and attach
|
||||
your document's source code. This allows the maintainers to do their jobs faster, and
|
||||
means your revised document will appear on the site faster.
|
||||
If you haven't heard anything in 5 calendar days,
|
||||
please follow up with an e-mail to make sure things are still in
|
||||
process. </para>
|
||||
|
||||
<para>If your text contains extras, such as graphics or a
|
||||
special catalog, create a .tar.gz file with all the files in it,
|
||||
including the XML source code, and mail it as an attachment to
|
||||
the submit list.</para>
|
||||
|
||||
<para>If you are using the LDP CVS tree while developing
|
||||
your document, the LDP will still need to be notified when your
|
||||
document is ready to be published. E-mail should be sent to
|
||||
<email>submit@en.tldp.org</email>. Indicate
|
||||
the title of your document and the relative path to the
|
||||
file(s) in the LDP CVS tree within your message. </para>
|
||||
|
||||
<para> To get a CVS account please refer to: <ulink
|
||||
url="http://tldp.org/cvs/">http://tldp.org/cvs/</ulink>
|
||||
</para>
|
||||
</section>
|
||||
<section id="compilations">
|
||||
<title>Publishing Compilations of LDP Documents</title>
|
||||
<para>
|
||||
If you are interested in publishing a collection of
|
||||
LDP documents, please visit <ulink
|
||||
url="http://www.tldp.org/manifesto.html#pub">http://www.tldp.org/manifesto.html#pub</ulink>
|
||||
for more information.
|
||||
</para>
|
||||
</section>
|
||||
-->
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
<!--
|
||||
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'>
|
||||
-->
|
||||
|
||||
<para>
|
||||
The LDP provides optional CVS access to its authors. This enables
|
||||
collaborative writing and has the following positive effects:
|
||||
</para>
|
||||
|
||||
<orderedlist inheritnum="ignore" continuation="restarts">
|
||||
<listitem>
|
||||
<para> CVS will keep an off-site backup of your documents. In
|
||||
the event that you hand over a document to another author,
|
||||
they can just retrieve the document from CVS and continue
|
||||
on. In the event you need to go back to a previous version of
|
||||
a document, you can retrieve it as well. </para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>However difficult from an organizational point of view, it's great to have multiple people working on the same
|
||||
document. CVS enables you to do this. You can have CVS tell you what changes were made by another author
|
||||
while you were editing your copy, and
|
||||
integrate those changes.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>CVS keeps a log of what changes were made. These logs (and
|
||||
a date stamp) can be placed automatically inside your documents
|
||||
when they are published.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> CVS can be combined with scripts to automatically
|
||||
update the LDP web site with new documentation as it's written
|
||||
and submitted. This is not in place yet, but it is a goal.
|
||||
Currently, CVS updates signal the HOWTO coordinator to
|
||||
update the LDP web page, meaning that if you use CVS, you're not
|
||||
required to e-mail your XML code. (Although you do
|
||||
still need to send the submit list an email when you
|
||||
are ready for your document to be published, because the whole publishing process has not been fully automated yet.) </para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
|
||||
<note><title>Access to our CVS repository</title>
|
||||
<para>Only authors with at least three submissions get access to our CVS, see <xref linkend="cvs" />.</para>
|
||||
</note>
|
||||
|
|
@ -1,242 +0,0 @@
|
|||
<!--
|
||||
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'>
|
||||
-->
|
||||
<appendix id="cvs">
|
||||
<title>Concurrent Version System (CVS)</title>
|
||||
|
||||
&cvs-why;
|
||||
|
||||
<para>
|
||||
You can browse the LDP CVS repository via the web at <ulink
|
||||
url="http://cvs.tldp.org/">http://cvs.tldp.org/</ulink>.
|
||||
</para>
|
||||
|
||||
<section id="getaccount">
|
||||
<title> Getting a CVS account </title>
|
||||
|
||||
<caution>
|
||||
<title>CVS accounts will not be granted to all applicants</title>
|
||||
<para>To be granted a CVS account you must qualify under one of the following categories:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>authors with documents already in the collection who have made a minimum of three submits to the LDP through <email>submit@en.tldp.org</email></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>technical and language reviewers approved by one of the Review Coordinators</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>new authors in the review process (also requires approval from one of the Review Coordinators)</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Please do not apply for a CVS account if you do not qualify.</para>
|
||||
</caution>
|
||||
|
||||
<para>
|
||||
If you qualify for a CVS account you may apply for one contacting CVS master Sergiusz <ulink url="mailto:ser@gnu.org" />
|
||||
Include information about which documents you maintain.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="usingcvs">
|
||||
<title>Using CVS</title>
|
||||
<section id="cvs-setup">
|
||||
<title>Setting Up Your CVS Account</title>
|
||||
<para> First you'll need to get an account at the LDP's CVS
|
||||
Repository. Please see the notes above on obtaining an account. This repository houses various documents including
|
||||
HOWTOs and Guides. Documents are sorted by the type of document (for
|
||||
example a HOWTO or a Guide), and by the markup language the document
|
||||
uses (for example DocBook or LinuxDoc).
|
||||
</para>
|
||||
|
||||
<para>When your account is ready you can log in using one of the following commands. In all instances <replaceable>your_userid</replaceable> should be replaced by the user name you were issued in the response email. You will be prompted for a password after this first step.</para>
|
||||
|
||||
<variablelist>
|
||||
<title>Initializing Your CVS Account</title>
|
||||
|
||||
<varlistentry>
|
||||
<term>Linux system</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<command>cvs <parameter>-d :pserver:<replaceable>your_userid</replaceable>@cvs.tldp.org:/cvsroot</parameter> login</command>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Windows system</term>
|
||||
<listitem>
|
||||
<para><command>set <varname>CVSROOT</varname>=":pserver:<replaceable>your_userid</replaceable>@cvs.tldp.org:/cvsroot"</command>
|
||||
</para>
|
||||
<para><command>cvs <parameter>-d %CVSROOT%</parameter> login</command></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para> Wait patiently while the system tries to log you in. It can often take more
|
||||
that 10-20 seconds for the system to either accept (or reject)
|
||||
your password. Once you've
|
||||
used <command>cvs login</command> for the first time and have
|
||||
been given access to the system, your password is stored in
|
||||
<filename>.cvspass</filename> and you will not
|
||||
have to use <command>cvs login</command>
|
||||
again. Just set the CVSROOT with the export command listed above
|
||||
and continue on. If TLDP's CVS server is the only one you work with, you might also add an <command>export <varname>CVSROOT</varname></command> line to your <filename>~/.bashrc</filename> shell configuration file.</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="get-repository">
|
||||
<title>Getting the Documents</title>
|
||||
<para>
|
||||
You can get the entire repository (about 150 MB) with: <command>cvs checkout LDP</command>
|
||||
</para>
|
||||
|
||||
<para> Or you can get the source for your own document with:
|
||||
<command>cvs checkout LDP/howto/docbook/YOUR-HOWTO.xml</command> OR
|
||||
<command>cvs checkout LDP/guide/docbook/YOURGUIDE</command>
|
||||
</para>
|
||||
|
||||
<para>Windows users will need to use a modified version of this command. Instead they should use:
|
||||
<command>cvs -d %CVSROOT% checkout LDP/howto/docbook/YOUR-HOWTO.xml</command>
|
||||
</para>
|
||||
|
||||
<note><title>Keep an overview</title><para>
|
||||
<command>checkout</command> will add the full directory structure
|
||||
from tldp.org on down. Although it doesn't really matter where
|
||||
you put these files on your local file system you may not want to
|
||||
bury the directories too deeply.
|
||||
</para></note>
|
||||
</section>
|
||||
|
||||
<section id="cvs-commands">
|
||||
<title>CVS Commands</title>
|
||||
<variablelist>
|
||||
<title>CVS Commands: a brief reminder</title>
|
||||
|
||||
<varlistentry>
|
||||
<term>commit</term>
|
||||
<listitem><para>
|
||||
This CVS command will upload your changes to the CVS server.</para>
|
||||
<para>Please be sure to include a useful description of the changes that have been made to your document.</para>
|
||||
<para>If you want to bypass the editor screen you can use </para>
|
||||
<cmdsynopsis><command>
|
||||
cvs <option>commit</option> <option>-m "A description of the work done on this version of the document."</option>
|
||||
</command></cmdsynopsis>
|
||||
|
||||
|
||||
<note><title>Ready for publication warning</title><para>You must still email <email>submit@en.tldp.org</email>
|
||||
when you are ready to have your changes
|
||||
appear on the live site. Your email should include the relative
|
||||
path to the file(s) in the LDP CVS tree that you wish to
|
||||
update.
|
||||
</para></note>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>add</term>
|
||||
<listitem><para>
|
||||
You can add new files to your CVS repository. These may be image
|
||||
files or additional XML files. First check that your HOWTO is in
|
||||
its own directory. You may want to coordinate with the
|
||||
people at <email>submit@en.tldp.org</email> to ensure you can
|
||||
add graphics or other files to your HOWTO.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Copy the files you want to add into your local CVS repository
|
||||
(where all of your downloaded/working files are). Then:</para>
|
||||
<cmdsynopsis><command>cvs add <replaceable>filename</replaceable></command></cmdsynopsis>
|
||||
<para>
|
||||
After you've added the files, you still need to <command>commit</command> them to the
|
||||
repository (see above).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>remove</term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>$Id$</term>
|
||||
<listitem><para>
|
||||
While this is not a CVS <quote>command</quote> it can be used to
|
||||
automatically insert information about the file including the
|
||||
time and date it was last modified, the version number it was
|
||||
assigned by the CVS and the filename of this particular file.
|
||||
The output will look like this:
|
||||
<computeroutput>$Id: cvs.xml,v 1.9 2002/04/21 09:44:26 serek Exp
|
||||
$</computeroutput>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
<para>
|
||||
If you need to change a file name, you
|
||||
still need to use the <command>add</command> command. First remove the copy of the
|
||||
file from your local disk. Then remove it from the CVS tree with:
|
||||
<command>cvs remove <replaceable>filename</replaceable></command>.
|
||||
As with the <command>add</command> command, you need to <command>>commit</command> your
|
||||
removed file. Finally, now that the old file has been removed, add
|
||||
your new file using the instructions above (first <command>add</command> and then
|
||||
<command>commit</command> the additional file).
|
||||
</para>
|
||||
|
||||
<section id="recovery">
|
||||
<title>Recovering old versions</title>
|
||||
<para>
|
||||
There you are, typing away, when you screw up. Real bad.
|
||||
Doesn't matter what it is, but suffice it to say that you've
|
||||
toasted not only the version on your local drive, but
|
||||
created a new version on the CVS server. What you need
|
||||
to do is go back in time and resurrect an older
|
||||
version of your file.
|
||||
</para>
|
||||
<para>
|
||||
To do this, you'll need to know the version number of the
|
||||
file you want to retrieve. <command>cvs diff</command>
|
||||
will give a list of revisions if there are differences. You
|
||||
can pick the revision number, subtract one, and that is
|
||||
probably the revision you want to look at.
|
||||
</para>
|
||||
<para>
|
||||
The command</para>
|
||||
<cmdsynopsis><command>cvs -Q update -p -r <replaceable>revision</replaceable>
|
||||
<replaceable>filename</replaceable></command></cmdsynopsis>
|
||||
<para>will output to stdout
|
||||
the contents of the <replaceable>revision</replaceable> version
|
||||
of <replaceable>filename</replaceable>. You can pipe it to
|
||||
<command>more</command> or redirect the output to a file.
|
||||
Conveniently, you can redirect stdout to a file called
|
||||
<replaceable>filename</replaceable>. Your local file
|
||||
is now the revision you want, and</para>
|
||||
<cmdsynopsis><command>cvs update</command></cmdsynopsis>
|
||||
<para>will update the CVS server with the new (old)
|
||||
version of <replaceable>filename</replaceable>.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section id="cvs-resources">
|
||||
<title>CVS Resources</title>
|
||||
<para> If you're completely new to CVS, there are a few web pages
|
||||
you may want to look at which can help you out: </para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para> <ulink
|
||||
url="http://cvshome.org/docs/blandy.html">http://cvshome.org/docs/blandy.html</ulink>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> <ulink
|
||||
url="http://www.loria.fr/~molli/cvs/doc/cvs_toc.html">http://www.loria.fr/~molli/cvs/doc/cvs_toc.html</ulink></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</appendix>
|
||||
|
|
@ -79,23 +79,4 @@
|
|||
</itemizedlist>
|
||||
<para>Once the push request is accepted, you can remove the branch using <command>git branch -D <replaceable>MyNewBranch</replaceable></command></para>
|
||||
</section>
|
||||
<!--
|
||||
<section id="git-resources">
|
||||
<title>git resources</title>
|
||||
<para>If you're completely new to git, there are a few web pages
|
||||
you may want to look at which can help you out: </para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para> <ulink
|
||||
url="http://cvshome.org/docs/blandy.html">http://cvshome.org/docs/blandy.html</ulink>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para> <ulink
|
||||
url="http://www.loria.fr/~molli/cvs/doc/cvs_toc.html">http://www.loria.fr/~molli/cvs/doc/cvs_toc.html</ulink></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
-->
|
||||
</appendix>
|
||||
|
|
|
|||
|
|
@ -404,36 +404,6 @@ url="http://tldp.org/HOWTO/HOWTO-INDEX/" /></bibliosource>
|
|||
</biblioentry>
|
||||
</bibliodiv>
|
||||
|
||||
<bibliodiv id="ref-cvs">
|
||||
<title>Software: CVS</title>
|
||||
|
||||
<biblioentry>
|
||||
<title>CVS: Project Management</title>
|
||||
<bibliosource><ulink url="http://doc.cs.byu.edu/programming/cvs/" /></bibliosource>
|
||||
<author><firstname>Byron</firstname><surname>Clark</surname></author>
|
||||
</biblioentry>
|
||||
|
||||
<biblioentry>
|
||||
<title>CVS</title>
|
||||
<bibliosource><ulink
|
||||
url="http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/cvstute/cvstute.html" /></bibliosource>
|
||||
<author><firstname>Ashley J.S.</firstname><surname>Mills</surname></author>
|
||||
<author><firstname>Alan P.</firstname><surname>Sexton</surname></author>
|
||||
</biblioentry>
|
||||
|
||||
<biblioentry>
|
||||
<title>CVS--Concurrent Versions System</title>
|
||||
<bibliosource><ulink url="http://www.loria.fr/~molli/cvs/doc/cvs_toc.html" /></bibliosource>
|
||||
<author><firstname>Pascal</firstname><surname>Molli</surname></author>
|
||||
</biblioentry>
|
||||
|
||||
<biblioentry>
|
||||
<title>Learning About CVS </title>
|
||||
<bibliosource><ulink url="http://cvshome.org/docs/" /></bibliosource>
|
||||
</biblioentry>
|
||||
|
||||
</bibliodiv>
|
||||
|
||||
<bibliodiv id="ref-software-edit">
|
||||
<title>Software: Emacs</title>
|
||||
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@
|
|||
This is because Linux is only the kernel, not the applications that run
|
||||
on it. Most of the basic command line utilities were written by the
|
||||
Free Software Foundation while developing their GNU operating system.
|
||||
Among those utilities are some of the most basic commands like cp, mv
|
||||
Among those utilities are some of the most basic commands like cp, mv,
|
||||
lsof, and dd.</para>
|
||||
|
||||
<para>In a nutshell, what happened was, the FSF <indexterm id="fsf">
|
||||
|
|
|
|||
|
|
@ -136,7 +136,7 @@
|
|||
|
||||
<para>The single most important service in a UNIX system is
|
||||
provided by <command>init</command><indexterm id="ch02-init">
|
||||
<primary>init</primary></indexterm> <command>init</command>
|
||||
<primary>init</primary></indexterm>. <command>init</command>
|
||||
is started as the first process of every UNIX system, as the last
|
||||
thing the kernel does when it boots. When <command>init</command>
|
||||
starts, it continues the boot process by doing various startup
|
||||
|
|
@ -215,7 +215,7 @@
|
|||
<command>getty</command> for each terminal upon which logins are to
|
||||
be allowed. <command>getty</command> reads the username and runs
|
||||
the <command>login</command><indexterm id="ch02-login">
|
||||
<primary>login</primary></indexterm>program, which reads the password.
|
||||
<primary>login</primary></indexterm> program, which reads the password.
|
||||
If the username and password are correct, <command>login</command> runs
|
||||
the shell. When the shell terminates, i.e., the user logs out, or
|
||||
when <command>login</command> terminated because the username and
|
||||
|
|
|
|||
Loading…
Reference in New Issue