[Gnu-arch-users] Some Tutorial Fixes

[John Goerzen]

Tom,

I made a few fixes to the tutorial.  You may grab them in the form of
patches from address@hidden/tla-docs--dev--1.0 at
http://quux.org:70/devel/arch/upstreams.

Changes include:

2003-09-02 04:28:45 GMT John Goerzen <address@hidden>   patch-3

    Summary:
      Fixed mirroring example
    Revision:
      tla-docs--dev--1.0--patch-3

    The mirroring example did not use a fully-qualified archive name (just an
    e-mail address).  Made it a valid example.

    modified files:
     src/mirroring-archives.doc


2003-09-02 03:25:42 GMT John Goerzen <address@hidden>   patch-2

    Summary:
      Command updating
    Revision:
      tla-docs--dev--1.0--patch-2

    introducing-reply: removed "--in-place" and "--in-place ." to correspond
    with current tla versions
    
    selected-files-commits: larch -> tla
    
    selected-files-comments: removed --files from examples and prose;
    grammatical fix "let's" -> "lets"
    
    elementary-branches: remove --in-place and . from tla replay

    modified files:
     src/elementary-branches.doc src/introducing-replay.doc
     src/selected-files-commits.doc


2003-09-02 03:12:48 GMT John Goerzen <address@hidden>   patch-1

    Summary:
      Corrected various minor problems
    Revision:
      tla-docs--dev--1.0--patch-1

    new-project: s/hello-world--devo/hello-world--mainline/
    
    locating-archives: Fixed a paragraph that was incorrectly formatted as
    source code

    modified files:
     src/locating-archives.doc src/new-project.doc


2003-09-02 02:23:31 GMT John Goerzen <address@hidden>   base-0

    Summary:
      tag of address@hidden/docs-tla--devo--1.0--patch-9
    Revision:
      tla-docs--dev--1.0--base-0

    (automatically generated log message)

    new patches:
     address@hidden/docs-tla--devo--1.0--base-0
     address@hidden/docs-tla--devo--1.0--patch-1
     address@hidden/docs-tla--devo--1.0--patch-2
     address@hidden/docs-tla--devo--1.1--base-0
     address@hidden/docs-tla--devo--1.1--patch-1
     address@hidden/docs-tla--devo--1.1--patch-2
     address@hidden/docs-tla--devo--1.1--patch-3
     address@hidden/docs-tla--devo--1.1--patch-4
     address@hidden/docs-tla--devo--1.1--patch-5
     address@hidden/docs-tla--devo--1.1--patch-6
     address@hidden/docs-tla--devo--1.1--patch-7
     address@hidden/docs-tla--devo--1.1--patch-8
     address@hidden/docs-tla--devo--1.1--patch-9
     address@hidden/docs-tla--devo--1.1--patch-10
     address@hidden/docs-tla--devo--1.1--patch-11
     address@hidden/docs-tla--devo--1.0--base-0
     address@hidden/docs-tla--devo--1.0--patch-1
     address@hidden/docs-tla--devo--1.0--patch-2
     address@hidden/docs-tla--devo--1.0--patch-3
     address@hidden/docs-tla--devo--1.0--patch-4
     address@hidden/docs-tla--devo--1.0--patch-5
     address@hidden/docs-tla--devo--1.0--patch-6
     address@hidden/docs-tla--devo--1.0--patch-7
     address@hidden/docs-tla--devo--1.0--patch-8
     address@hidden/docs-tla--devo--1.0--patch-9


Diff is:

A  
{arch}/tla-docs/tla-docs--dev/tla-docs--dev--1.0/address@hidden/patch-log/patch-1
A  
{arch}/tla-docs/tla-docs--dev/tla-docs--dev--1.0/address@hidden/patch-log/patch-2
A  
{arch}/tla-docs/tla-docs--dev/tla-docs--dev--1.0/address@hidden/patch-log/patch-3
M  src/locating-archives.doc
M  src/mirroring-archives.doc
M  src/new-project.doc
M  src/selected-files-commits.doc
M  src/introducing-replay.doc
M  src/elementary-branches.doc

* modified files

--- orig/src/elementary-branches.doc
+++ mod/src/elementary-branches.doc
@@ -346,9 +346,7 @@
 
        % cd ~/wd/hw-candice
 
-       % tla replay --in-place \
-               -A address@hidden \
-               . \
+       % tla replay -A address@hidden \
                 hello-world--mainline--0.1
        [...]
 


--- orig/src/introducing-replay.doc
+++ mod/src/introducing-replay.doc
@@ -16,7 +16,7 @@
 Another option is `replay':
 
         % cd ~/wd/project-tree
-       % tla replay --in-place .
+       % tla replay
         [....]
 
 What does that actually do?
@@ -84,27 +84,27 @@
 provides a more automated way to accomplish that same effect:
 
        % cd ~/wd/hw-patch-1
-       % tla replay --in-place .
+       % tla replay
        [....]
        % tla whats-missing
        [no output]
 
-`replay --in-place' will do just what we've described: get patches
+`replay' will do just what we've described: get patches
 from the archive and apply them one-by-one.   One word of caution,
 though: if one of those patches generates conflicts, `replay' will
 stop there and let you fix the conflicts.  You can then pick up where
-`replay' left off by running `replay --in-place' a second time.
+`replay' left off by running `replay' a second time.
 
  * 
  */
 
 
 /************************************************************************
- *(h1 "How it Works -- replay --in-place")
+ *(h1 "How it Works -- replay")
  * 
 
 If you've followed along with the tutorial so far, the way that
-`replay --in-place' works should be pretty obvious.  In fact, it's
+`replay' works should be pretty obvious.  In fact, it's
 just exactly how we described it above.  `replay' uses `whats-missing'
 to find out what changes your tree is missing, `get-patch' to retrieve
 those changesets, and `dopatch' to apply them.   There's a fair amount


--- orig/src/locating-archives.doc
+++ mod/src/locating-archives.doc
@@ -94,9 +94,9 @@
 /************************************************************************
  *(h1 "Locating an Archive")
  * 
- Once an archive has been registered you can browse the categories, branches
- and versions of software available in that archive by using the abrowse
- command: 
+Once an archive has been registered you can browse the categories, branches
+and versions of software available in that archive by using the abrowse
+command: 
  
     % tla abrowse address@hidden
      linux


--- orig/src/mirroring-archives.doc
+++ mod/src/mirroring-archives.doc
@@ -76,7 +76,7 @@
 Assuming that you already have address@hidden' registered, you
 can create the remote mirror with:
 
-       % tla make-archive --mirror address@hidden $remote_location
+       % tla make-archive --mirror address@hidden $remote_location
 
 Arch will write directly to $remote_location, so it must be a writeable
 transport such as sftp, and not something such as standard http.
@@ -84,7 +84,7 @@
 You can initialize or incrementally update the contents of the remote
 mirror with:
 
-       % tla archive-mirror address@hidden
+       % tla archive-mirror address@hidden
 
 One common situation for many people is that they are able to 
 install static files as part of a web site, but they can't provide
@@ -93,7 +93,7 @@
 
 First, when running make-archive, you need to provide an extra flag:
 
-       % tla make-archive --listing --mirror address@hidden \
+       % tla make-archive --listing --mirror address@hidden \
                        $remote_location
 
 The `--listing' flag causes arch to keep `.listing' files up-to-date
@@ -105,7 +105,7 @@
 right time_.   If you know or suspect that has occurred, you can repair
 the archive in question by running archive-fixup as in this example:
 
-       % tla archive-fixup address@hidden
+       % tla archive-fixup address@hidden
 
 
  * 


--- orig/src/new-project.doc
+++ mod/src/new-project.doc
@@ -138,7 +138,7 @@
        % tla branches hello-world
        hello-world--mainline
 
-       % tla versions hello-world--devo
+       % tla versions hello-world--mainline
         hello-world--mainline--0.1
 
 


--- orig/src/selected-files-commits.doc
+++ mod/src/selected-files-commits.doc
@@ -80,7 +80,7 @@
 Sometimes the awkwardness is nearly unavoidable.  For example, if the
 trivial bug fix involves modifying files that you've already heavily
 modified, then again, the brute force technique may be the simplest
-approach (but also, take a look at `tla undo --help' and `larch redo
+approach (but also, take a look at `tla undo --help' and `tla redo
 --help').
 
 But there is a simpler way that sometimes applies:
@@ -90,18 +90,18 @@
 
 
 /************************************************************************
- *(h1 "Solving the Quick Fix Problem with commit --files")
+ *(h1 "Solving the Quick Fix Problem with commit --")
  * 
 
-As it turns out, the `commit' command has an option `--files' that
-let's you commit only the changes made to just a few files.
+As it turns out, `commit'
+lets you commit only the changes made to just a few files.
 
 If your quick fix changes `file-a.c' and `file-b.c', then after
 preparing a log message, you can commit just those files with:
 
-       % tla commit --files -- file-a.c file-b.c
+       % tla commit -- file-a.c file-b.c
 
-You should note that the files committed by `commit --files' must not
+You should note that the files committed this way must not
 be new files and that, even if those files have been renamed, the
 `commit' will record only the changes internal to those files, not the
 renames.