diff options
Diffstat (limited to 'doc/misc/erc.texi')
| -rw-r--r-- | doc/misc/erc.texi | 109 |
1 files changed, 73 insertions, 36 deletions
diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index fa5790f1527..95f9e4a20fe 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi | |||
| @@ -12,9 +12,9 @@ | |||
| 12 | @syncodeindex fn cp | 12 | @syncodeindex fn cp |
| 13 | 13 | ||
| 14 | @copying | 14 | @copying |
| 15 | This manual is for ERC version 5.2. | 15 | This manual is for ERC version 5.3. |
| 16 | 16 | ||
| 17 | Copyright @copyright{} 2005, 2006, 2007 Free Software Foundation, Inc. | 17 | Copyright @copyright{} 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
| 18 | 18 | ||
| 19 | @quotation | 19 | @quotation |
| 20 | Permission is granted to copy, distribute and/or modify this document | 20 | Permission is granted to copy, distribute and/or modify this document |
| @@ -72,7 +72,7 @@ and modified without restriction. | |||
| 72 | permission to redistribute ERC on | 72 | permission to redistribute ERC on |
| 73 | certain terms; it also explains that | 73 | certain terms; it also explains that |
| 74 | there is no warranty. | 74 | there is no warranty. |
| 75 | * GNU Free Documentation License:: The license for this documentation. | 75 | * GNU Free Documentation License:: The license for this documentation. |
| 76 | * Concept Index:: Search for terms. | 76 | * Concept Index:: Search for terms. |
| 77 | 77 | ||
| 78 | @detailmenu | 78 | @detailmenu |
| @@ -135,8 +135,8 @@ dependency issues. If desired, they may be found at the following | |||
| 135 | locations, or from your local GNU mirror. | 135 | locations, or from your local GNU mirror. |
| 136 | 136 | ||
| 137 | @itemize @bullet | 137 | @itemize @bullet |
| 138 | @item @uref{http://ftp.gnu.org/gnu/erc/erc-5.2-extras.tar.gz} | 138 | @item @uref{http://ftp.gnu.org/gnu/erc/erc-5.3-extras.tar.gz} |
| 139 | @item @uref{http://ftp.gnu.org/gnu/erc/erc-5.2-extras.zip} | 139 | @item @uref{http://ftp.gnu.org/gnu/erc/erc-5.3-extras.zip} |
| 140 | @end itemize | 140 | @end itemize |
| 141 | 141 | ||
| 142 | The rest of this chapter may be skipped if you are using the version of | 142 | The rest of this chapter may be skipped if you are using the version of |
| @@ -169,67 +169,100 @@ Alternatively, you can download the latest release from | |||
| 169 | Choose the development version if you want to live on the bleeding edge | 169 | Choose the development version if you want to live on the bleeding edge |
| 170 | of ERC development or try out new features before release. | 170 | of ERC development or try out new features before release. |
| 171 | 171 | ||
| 172 | @subheading GNU Arch | 172 | @cindex git version control system, using |
| 173 | The git version control system allows you to keep up-to-date with the | ||
| 174 | latest changes to the development version of ERC. It also allows you | ||
| 175 | to contribute changes (via commits, if you are have developer access to | ||
| 176 | the repository, or via patches, otherwise). If you would like to | ||
| 177 | contribute to ERC development, it is highly recommended that you use | ||
| 178 | git. | ||
| 173 | 179 | ||
| 174 | ERC is developed using GNU Arch. Downloading ERC with Arch and staying | 180 | If you are new to git, you might find this tutorial helpful: |
| 175 | up-to-date involves the following steps. | 181 | @uref{http://www.kernel.org/pub/software/scm/git/docs/tutorial.html}. |
| 182 | |||
| 183 | Downloading ERC with git and staying up-to-date involves the following | ||
| 184 | steps. | ||
| 176 | 185 | ||
| 177 | @enumerate | 186 | @enumerate |
| 178 | @cindex GNU Arch, installing | 187 | @item Install git. |
| 179 | @item Install arch | ||
| 180 | 188 | ||
| 181 | @itemize @bullet | 189 | @itemize @bullet |
| 182 | @item Debian: @kbd{apt-get install tla}. | 190 | @item Debian and Ubuntu: @kbd{apt-get install git-core}. |
| 183 | @item Other distributions: see @uref{ftp://ftp.gnu.org/gnu/gnu-arch/}. | 191 | @item Windows: @uref{http://git.or.cz/gitwiki/WindowsInstall}. |
| 192 | @item Other operating systems: download, compile, and install the source | ||
| 193 | from @uref{http://www.kernel.org/pub/software/scm/git/}, or find a git | ||
| 194 | package for your operating system. | ||
| 184 | @end itemize | 195 | @end itemize |
| 185 | 196 | ||
| 186 | @cindex GNU Arch, downloading ERC | 197 | @item Download the ERC development branch. |
| 187 | @item Register the archive. | 198 | |
| 199 | If you have developer access to ERC, do: | ||
| 200 | |||
| 201 | @example | ||
| 202 | git clone ssh://loginname@@git.sv.gnu.org/srv/git/erc.git | ||
| 203 | @end example | ||
| 204 | |||
| 205 | otherwise, do: | ||
| 206 | |||
| 188 | @example | 207 | @example |
| 189 | tla register-archive -f http://arch.sv.gnu.org/archives/erc/erc | 208 | git clone git://git.sv.gnu.org/erc.git |
| 190 | @end example | 209 | @end example |
| 191 | 210 | ||
| 192 | @item Download the ERC source code. | 211 | If you are behind a restrictive firewall, and do not have developer |
| 212 | access, then do the following instead: | ||
| 213 | |||
| 193 | @example | 214 | @example |
| 194 | # Download ERC into the @file{erc} directory. | 215 | git clone http://git.sv.gnu.org/r/erc.git |
| 195 | tla get erc@@sv.gnu.org/erc--main--0 erc | ||
| 196 | @end example | 216 | @end example |
| 197 | 217 | ||
| 198 | @item List upstream changes that are missing from your local copy. | 218 | @item List upstream changes that are missing from your local copy. |
| 199 | Do this whenever you want to see whether new changes have been committed | 219 | Do this whenever you want to see whether new changes have been committed |
| 200 | to ERC. | 220 | to ERC. If you wish, you may skip this step and proceed directly to |
| 221 | the ``update'' step. | ||
| 201 | 222 | ||
| 202 | @example | 223 | @example |
| 203 | # Change to the source directory you are interested in. | 224 | # Change to the source directory you are interested in. |
| 204 | cd erc/ | 225 | cd erc |
| 226 | |||
| 227 | # Fetch new changes from the repository, but don't apply them yet | ||
| 228 | git fetch origin | ||
| 205 | 229 | ||
| 206 | # Display the summary of changes | 230 | # Display log messages for the new changes |
| 207 | tla missing --summary | 231 | git log HEAD..origin |
| 208 | @end example | 232 | @end example |
| 209 | 233 | ||
| 210 | @cindex GNU Arch, updating ERC | 234 | ``origin'' is git's name for the location where you originally got ERC |
| 211 | @item Update to the latest version by replaying missing changes. | 235 | from. You can change this location at any time by editing the |
| 236 | @file{.git/config} file in the directory where the ERC source was | ||
| 237 | placed. | ||
| 238 | |||
| 239 | @cindex updating ERC with git | ||
| 240 | @item Update to the latest version by pulling in any missing changes. | ||
| 241 | |||
| 212 | @example | 242 | @example |
| 213 | cd erc | 243 | cd erc |
| 214 | tla update | 244 | git pull origin |
| 215 | @end example | 245 | @end example |
| 216 | 246 | ||
| 247 | git will show how many files changed, and will provide a visual display | ||
| 248 | for how many lines were changed in each file. | ||
| 249 | |||
| 217 | @end enumerate | 250 | @end enumerate |
| 218 | 251 | ||
| 219 | If you are new to Arch and want to learn more about developing ERC with | 252 | There are other ways to interact with the ERC repository. |
| 220 | it, visit @uref{http://emacswiki.org/cgi-bin/wiki/ErcDevelopment} for | ||
| 221 | full instructions. | ||
| 222 | 253 | ||
| 223 | @subheading Development snapshots | 254 | @itemize |
| 255 | @item Browse git repo: @uref{http://git.sv.gnu.org/gitweb/?p=erc.git} | ||
| 256 | @item Latest development snapshot: @uref{http://mwolson.org/static/dist/erc-latest.tar.gz} | ||
| 257 | @item Latest development snapshot (zip file): @uref{http://mwolson.org/static/dist/erc-latest.zip} | ||
| 258 | @end itemize | ||
| 224 | 259 | ||
| 225 | @cindex development snapshot | 260 | The latest development snapshot can lag behind the git repo by as much |
| 226 | Alternatively, the latest development snapshot may be downloaded in both | 261 | as 20 minutes, but never more than that. |
| 227 | ``.tar.gz'' and ``.zip'' forms. | ||
| 228 | 262 | ||
| 229 | @itemize @bullet | 263 | For further information on committing changes to ERC and performing |
| 230 | @item @uref{http://www.mwolson.org/static/dist/erc-latest.tar.gz} | 264 | development, please consult |
| 231 | @item @uref{http://www.mwolson.org/static/dist/erc-latest.zip} | 265 | @uref{http://emacswiki.org/cgi-bin/wiki/ErcDevelopment}. |
| 232 | @end itemize | ||
| 233 | 266 | ||
| 234 | 267 | ||
| 235 | @node Installation, Getting Started, Obtaining ERC, Top | 268 | @node Installation, Getting Started, Obtaining ERC, Top |
| @@ -1009,6 +1042,10 @@ ERC became an official GNU project, and development moved to | |||
| 1009 | @uref{http://sv.gnu.org/projects/erc}. We switched to using GNU Arch as | 1042 | @uref{http://sv.gnu.org/projects/erc}. We switched to using GNU Arch as |
| 1010 | our revision control system. Our mailing list address changed as well. | 1043 | our revision control system. Our mailing list address changed as well. |
| 1011 | 1044 | ||
| 1045 | @item 2007 | ||
| 1046 | |||
| 1047 | We switched to using git for our version control system. | ||
| 1048 | |||
| 1012 | @end itemize | 1049 | @end itemize |
| 1013 | 1050 | ||
| 1014 | @node Copying, GNU Free Documentation License, History, Top | 1051 | @node Copying, GNU Free Documentation License, History, Top |