[PATCH] download.txt: No more Cogito. Describe branches.

Kalle Olavi Niemitalo <[email protected]>
Newsgroups gmane.comp.web.links
Message-ID <[email protected]>
I am not entirely satisfied with the result.
Can someone with good English or Git skills check this?

download.txt: No more Cogito.  Describe branches.

---
commit 71b71d34283fe4f10dc70c15a8a31dfe0878a6d6
tree 0caddb5b0f4ff370c9b02b6d2a5258f72acf920a
parent 6317e6c9e49cd5a9b2650949331b05ec0f6d6a20
author Kalle Olavi Niemitalo <[email protected]> Sat, 04 Aug 2007 22:07:36 +0300
committer Kalle Olavi Niemitalo <[email protected]> Sat, 04 Aug 2007 22:08:17 +0300

 download.html |  121 +++++++++++++++++++++++++++++++++++++++++-------------
 download.txt  |  127 ++++++++++++++++++++++++++++++++++++++++++++-------------
 2 files changed, 191 insertions(+), 57 deletions(-)

diff --git a/download.html b/download.html
index 30b1541..d87a489 100644
--- a/download.html
+++ b/download.html
@@ -146,47 +146,110 @@ is given in the following section.</p>
 </div>
 <h2>ELinks via GIT</h2>
 <div class="sectionbody">
-<p>To get access to ELinks via GIT you will need to have the following tools
-installed on your system:</p>
+<p>To get access to ELinks via GIT you will need to have GIT installed on
+your system. Please see the <a href="http://git.or.cz/">GIT website</a> for pointers
+to source and binary packages and documentation. Pick the most recent
+version.  (We no longer recommend
+<a href="http://article.gmane.org/gmane.comp.version-control.git/45014">Cogito</a>.)</p>
+<p>First, get yourself a copy of the ELinks repository by doing:</p>
+<table border="1" class="code"><tr><td><pre>% git clone http://repo.or.cz/r/elinks.git
+% cd elinks</pre></td></tr></table>
+<p>(If the operation hangs or fails, try also cloning from
+<tt>git://repo.or.cz/elinks.git</tt> or <tt>http://elinks.cz/elinks.git</tt>.
+However, your firewall may block the GIT protocol, and cloning
+from elinks.cz takes much longer.  You can add more sources with
+<tt>git remote add</tt> after you have the clone.)</p>
+<p>You now have a working copy of the local &#8220;master&#8221; branch, which is
+tracking the remote &#8220;origin/master&#8221; branch, where the unstable
+version of ELinks is kept. If you want to use some other remote
+branch, e.g. &#8220;origin/elinks-0.12&#8221;, create a corresponding local
+branch with this command:</p>
+<table border="1" class="code"><tr><td><pre>% git checkout --track -b elinks-0.12 origin/elinks-0.12</pre></td></tr></table>
+<p>You can get a list of remote branches with <tt>git branch -r</tt>,
+<tt>git remote show origin</tt>, or <tt>git ls-remote &#8212;heads origin</tt>.
+The following branches are known to exist:</p>
 <dl>
 <dt>
-<a href="http://kernel.org/pub/software/scm/git/">The GIT core</a>
+master
+</dt>
+<dd>
+        The unstable version. As of August 2007, this is ELinks
+        0.13.GIT, but few commits are made directly here; instead,
+        they are made in &#8220;elinks-0.12&#8221; and later merged here.
+</dd>
+<dt>
+elinks-0.12
+</dt>
+<dd>
+        The ELinks 0.12 series. Forked from &#8220;master&#8221; on 2007-04-22.
+        Bug fixes only, until ELinks 0.12.0 has been released.
+</dd>
+<dt>
+elinks-0.11
+</dt>
+<dd>
+        The ELinks 0.11 series. Mainly bug fixes are made here.
+</dd>
+<dt>
+REL_0_10
 </dt>
 <dd>
-        This is a set of lowlevel tools able of accessing and modifying
-        a GIT tree. Pick the most recent version.
+        The ELinks 0.10 series. Unmaintained since 2007-03-17.
 </dd>
 <dt>
-<a href="http://kernel.org/pub/software/scm/cogito/">The Cogito tools</a>
+utf8
 </dt>
 <dd>
-        Which is a set of bash scripts layered on top of the GIT core with the
-        aim of making interacting with GIT trees more pleasent.
-        Pick the most recent version.
+        UTF-8 terminal support for ELinks 0.12.GIT. Forked from
+        &#8220;master&#8221; on 2006-01-14. Was merged back to &#8220;master&#8221;
+        on 2006-07-21 and is no longer developed separately.
+</dd>
+<dt>
+witekfl
+</dt>
+<dd>
+        Changes to be reviewed and then applied to &#8220;master&#8221; or
+        &#8220;elinks-0.12&#8221;.
+</dd>
+<dt>
+HEAD
+</dt>
+<dd>
+        An alias for the default branch, currently &#8220;master&#8221;.
 </dd>
 </dl>
-<p>In the following we will only focus on getting the most recent version of the
-stable and unstable trees. See
-<a href="http://kernel.org/pub/software/scm/cogito/docs/introduction.html">the Cogito introduction</a>
-or <a href="http://kernel.org/pub/software/scm/cogito/docs/">the Cogito manpages</a>.
-for information on doing more advanced things with Cogito.</p>
-<p>You can get the latest <strong>unstable</strong> development version by doing:</p>
-<table border="1" class="code"><tr><td><pre>% cg clone http://elinks.cz/elinks.git
-% cd elinks</pre></td></tr></table>
-<p>You can also get the latest <strong>stable</strong> development version via GIT. Note that
-development in the stable branch is more slow and mostly involves backporting
-of bug fixes. Just do this:</p>
-<table border="1" class="code"><tr><td><pre>% cg clone http://elinks.cz/elinks.git#{stable-branch} {stable-branch}
-% cd {stable-branch}</pre></td></tr></table>
-<p>There may also be some other branches for separate development of some larger
-experimental features etc. The old CVS history is available in a separate
-archive that can be grafted onto either the stable or unstable tree by simply
-running the following command in the cloned ELinks repository:</p>
-<table border="1" class="code"><tr><td><pre>% sh contrib/grafthistory.sh</pre></td></tr></table>
-<p>Note, it requires <tt>wget(1)</tt> and will download about 80M.</p>
+<p>After you have checked out the right branch, generate the files
+that we do not keep in GIT:</p>
+<table border="1" class="code"><tr><td><pre>% ./autogen.sh</pre></td></tr></table>
+<p>And then you can compile ELinks as described on
+<a href="documentation/installation.html">the installation page</a>
+or in the INSTALL file.</p>
+<h3>Keeping up to date</h3>
 <p>You can browse <a href="http://repo.or.cz/w/elinks.git">the GIT tree</a> online.
 You can also browse
 <a href="http://cvsweb.elinks.cz/cvsweb.cgi/elinks/">the old CVS tree</a>.</p>
+<p>As new commits are made, your clone of the ELinks repository will
+become out of date.  Instead of making a new clone from scratch,
+you can quickly update the old one with:</p>
+<table border="1" class="code"><tr><td><pre>% git pull</pre></td></tr></table>
+<p>This command both updates the remote branches (e.g. &#8220;origin/elinks-0.12&#8221;)
+and merges the changes to your local branch (e.g. &#8220;elinks-0.12&#8221;).
+You can then compile the new version. It is usually not necessary
+to run <tt>./autogen.sh</tt> first.</p>
+<p>Adding more data to the repository gradually leaves more and more
+small files in the <tt>.git/objects/??</tt> directories. To compress these
+files into a pack so that they take up less disk space, run this:</p>
+<table border="1" class="code"><tr><td><pre>% git gc</pre></td></tr></table>
+<p>To see commits almost in real time, you can join the
+<a href="community.html#irc">#ELinks IRC channel</a>, where the
+<a href="http://cia.vc/stats/project/ELinks">CIA.vc</a> bot announces them.
+However, it takes a while before the new commit is available
+at elinks.cz, and then some more before it is at repo.or.cz.</p>
+<p>The old CVS history is available in a separate archive that can be
+grafted onto either the stable or unstable tree by simply running the
+following command in the cloned ELinks repository:</p>
+<table border="1" class="code"><tr><td><pre>% sh contrib/grafthistory.sh</pre></td></tr></table>
+<p>Note, it requires <tt>wget(1)</tt> and will download about 80M.</p>
 </div>
 <h2>Getting ELinks up and running</h2>
 <div class="sectionbody">
@@ -205,7 +268,7 @@ You can also browse
         </span>
 </div>
 <p class="validate">
-        Last Modified: 10-Jul-2007 17:24:33 EEST.
+        Last Modified: 04-Aug-2007 22:07:58 EEST.
         Validate:
         <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a>
         <a href="http://validator.w3.org/check/referer">XHTML</a>.
diff --git a/download.txt b/download.txt
index 88e0451..1495553 100644
--- a/download.txt
+++ b/download.txt
@@ -102,49 +102,120 @@ is given in the following section.
 ELinks via GIT
 --------------
 
-To get access to ELinks via GIT you will need to have the following tools
-installed on your system:
+To get access to ELinks via GIT you will need to have GIT installed on
+your system. Please see the http://git.or.cz/[GIT website] for pointers
+to source and binary packages and documentation. Pick the most recent
+version.  (We no longer recommend
+http://article.gmane.org/gmane.comp.version-control.git/45014[Cogito].)
 
-http://kernel.org/pub/software/scm/git/[The GIT core]::
-	This is a set of lowlevel tools able of accessing and modifying
-	a GIT tree. Pick the most recent version.
+First, get yourself a copy of the ELinks repository by doing:
 
-http://kernel.org/pub/software/scm/cogito/[The Cogito tools]::
-	Which is a set of bash scripts layered on top of the GIT core with the
-	aim of making interacting with GIT trees more pleasent.
-	Pick the most recent version.
+	% git clone http://repo.or.cz/r/elinks.git
+	% cd elinks
 
-In the following we will only focus on getting the most recent version of the
-stable and unstable trees. See
-http://kernel.org/pub/software/scm/cogito/docs/introduction.html[the Cogito introduction]
-or http://kernel.org/pub/software/scm/cogito/docs/[the Cogito manpages]. 
-for information on doing more advanced things with Cogito. 
+(If the operation hangs or fails, try also cloning from
+`git://repo.or.cz/elinks.git` or `http://elinks.cz/elinks.git`.
+However, your firewall may block the GIT protocol, and cloning
+from elinks.cz takes much longer.  You can add more sources with
+`git remote add` after you have the clone.)
 
-You can get the latest *unstable* development version by doing:
+//////////////////////////////////////////////////////////////////////
+                                 real       user      sys
+http://repo.or.cz/r/elinks.git    5m35.358s 0m21.649s 0m6.060s
+http://repo.or.cz/r/elinks.git    7m53.854s 0m21.201s 0m6.164s
+git://repo.or.cz/elinks.git       7m17.302s 0m14.073s 0m1.872s
+git://repo.or.cz/elinks.git       8m3.286s  0m14.029s 0m1.836s
+http://elinks.cz/elinks.git      15m28.878s 0m24.250s 0m14.489s
+http://elinks.cz/elinks.git      15m39.615s 0m24.738s 0m14.589s
+//////////////////////////////////////////////////////////////////////
 
-	% cg clone http://elinks.cz/elinks.git
-	% cd elinks
+You now have a working copy of the local ``master'' branch, which is
+tracking the remote ``origin/master'' branch, where the unstable
+version of ELinks is kept. If you want to use some other remote
+branch, e.g. ``origin/elinks-0.12'', create a corresponding local
+branch with this command:
 
-You can also get the latest *stable* development version via GIT. Note that
-development in the stable branch is more slow and mostly involves backporting
-of bug fixes. Just do this:
+	% git checkout --track -b elinks-0.12 origin/elinks-0.12
 
-	% cg clone http://elinks.cz/elinks.git#{stable-branch} {stable-branch}
-	% cd {stable-branch}
+You can get a list of remote branches with `git branch -r`,
+`git remote show origin`, or `git ls-remote --heads origin`.
+The following branches are known to exist:
 
-There may also be some other branches for separate development of some larger
-experimental features etc. The old CVS history is available in a separate
-archive that can be grafted onto either the stable or unstable tree by simply
-running the following command in the cloned ELinks repository:
+master::
+	The unstable version. As of August 2007, this is ELinks
+	0.13.GIT, but few commits are made directly here; instead,
+	they are made in ``elinks-0.12'' and later merged here.
 
-	% sh contrib/grafthistory.sh
+elinks-0.12::
+	The ELinks 0.12 series. Forked from ``master'' on 2007-04-22.
+	Bug fixes only, until ELinks 0.12.0 has been released.
+
+elinks-0.11::
+	The ELinks 0.11 series. Mainly bug fixes are made here.
+
+REL_0_10::
+	The ELinks 0.10 series. Unmaintained since 2007-03-17.
+
+utf8::
+	UTF-8 terminal support for ELinks 0.12.GIT. Forked from
+	``master'' on 2006-01-14. Was merged back to ``master''
+	on 2006-07-21 and is no longer developed separately.
+
+witekfl::
+	Changes to be reviewed and then applied to ``master'' or
+	``elinks-0.12''.
+
+HEAD::
+	An alias for the default branch, currently ``master''.
+
+After you have checked out the right branch, generate the files
+that we do not keep in GIT:
+
+	% ./autogen.sh
+
+And then you can compile ELinks as described on
+link:documentation/installation.html[the installation page]
+or in the INSTALL file.
 
-Note, it requires `wget(1)` and will download about 80M.
+
+Keeping up to date
+~~~~~~~~~~~~~~~~~~
 
 You can browse http://repo.or.cz/w/elinks.git[the GIT tree] online.
 You can also browse
 http://cvsweb.elinks.cz/cvsweb.cgi/elinks/[the old CVS tree].
 
+As new commits are made, your clone of the ELinks repository will
+become out of date.  Instead of making a new clone from scratch,
+you can quickly update the old one with:
+
+	% git pull
+
+This command both updates the remote branches (e.g. ``origin/elinks-0.12'')
+and merges the changes to your local branch (e.g. ``elinks-0.12'').
+You can then compile the new version. It is usually not necessary
+to run `./autogen.sh` first.
+
+Adding more data to the repository gradually leaves more and more
+small files in the `.git/objects/??` directories. To compress these
+files into a pack so that they take up less disk space, run this:
+
+	% git gc
+
+To see commits almost in real time, you can join the
+link:community.html#irc[#ELinks IRC channel], where the
+http://cia.vc/stats/project/ELinks[CIA.vc] bot announces them.
+However, it takes a while before the new commit is available
+at elinks.cz, and then some more before it is at repo.or.cz.
+
+The old CVS history is available in a separate archive that can be
+grafted onto either the stable or unstable tree by simply running the
+following command in the cloned ELinks repository:
+
+	% sh contrib/grafthistory.sh
+
+Note, it requires `wget(1)` and will download about 80M.
+
 
 Getting ELinks up and running
 -----------------------------

_______________________________________________
elinks-dev mailing list
[email protected]
http://linuxfromscratch.org/mailman/listinfo/elinks-dev
signature.asc (application/pgp-signature, 188 B)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)

iD8DBQFGtNAFHm9IGt60eMgRAjiJAKCTB8h4OOKCm6aXoVg/J2jWPX4aRwCgt7TA
5MHf2WN1tfDI+P/HkWQFmco=
=Of5O
-----END PGP SIGNATURE-----
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.