From da018afd5a98c2864bdceb5c790bce13f646916f Mon Sep 17 00:00:00 2001 From: bringert Date: Thu, 17 Nov 2005 18:00:17 +0000 Subject: [PATCH] Documented how to record changes when using read-only access. --- doc/darcs.html | 86 ++++++++++++++++++++++++++++++-------------------- doc/darcs.txt | 17 ++++++++-- 2 files changed, 66 insertions(+), 37 deletions(-) diff --git a/doc/darcs.html b/doc/darcs.html index 813fa7574..b38f2a42f 100644 --- a/doc/darcs.html +++ b/doc/darcs.html @@ -19,30 +19,31 @@ GF has now been moved to a Darcs repository. No changes should be committed to t -
  • Read-write access +
  • Read-write access -
  • Troubleshooting +
  • Troubleshooting -
  • Further information about Darcs +
  • Further information about Darcs

    @@ -111,10 +112,25 @@ Get all new patches from the main repo: Without -a, you can choose which patches you want to get.

    +

    Recording local changes

    +

    +Since every copy is a repository, you can have local version control +of your changes. To record some changes, use: +

    +
    +  $ darcs record
+
    +

    +

    +This creates a patch against the previous version and stores it in your +local repository. +

    +

    Submitting patches

    If you are using read-only access, send your patches by email to -someone with write-access. Create the patch with: +someone with write-access. First record your changes in your local +repository, as described above. Then create the patch with: 

       $ darcs send -o mypatch.patch
@@ -127,7 +143,7 @@ sendmail or something equivalent installed, it is possible to send the
 patch directly from darcs. If so, replace -o mypatch.patch with
 --to=EMAIL where EMAIL is the address to send it to.
 
    
-
+
 
    Read-write access
    
 
    
 If you have an account on the Chalmers system and want read-write
@@ -135,7 +151,7 @@ access, you can access the repository using ssh.
 You need to be a member of the langtech group to push changes to
 the repository.
 
    
-
+
 
    Setting up your $PATH on the Chalmers system
    
 
    
 The darcs program has to be on your $PATH on the Chalmers
@@ -150,7 +166,7 @@ repository. To fix this, log in to your Chalmers account and run:
 Note that the path setup works differently on different Chalmers machines.
 The command above will setup you path on the newer machines correctly.
 
    
-
+
 
    Setting up ssh alias and ControlMaster
    
 
    
 In order to avoid typing in you password multiple times for each
@@ -188,7 +204,7 @@ with an earlier Darcs version you can mess up the repository.
 More information about the ControlMaster feature is available in 
 man ssh_config.
 
    
-
+
 
    Setting up an ssh ControlMaster connection
    
 
    
 Before connecting to the remote server, you need to set up a master
@@ -206,7 +222,7 @@ Start the master connection:
 NOTE: You need to have a ControlMaster connection running whenever you want to access the repo using ssh.
 You may want to create a script or alias for starting the connection.
 
    
-
+
 
    Getting a fresh copy
    
 
    
 Get your copy with (all on one line):
@@ -221,7 +237,7 @@ history for the repository. This saves space, bandwidth and CPU time,
 and most people don't need the full history of all changes in the
 past.
 
    
-
+
 
    Getting other people's changes?
    
 
    
 Get all new patches from the main repo:
@@ -233,7 +249,7 @@ Get all new patches from the main repo:
 
    
 Without -a, you can choose which patches you want to get.
 
    
-
+
 
    Commit your changes
    
 
    
 There are two steps to commiting a change to the main repo. First you
@@ -244,7 +260,7 @@ have to record the changes that you want to commit:

    -This creates a patch against the previous version and stores it in you +This creates a patch against the previous version and stores it in your local repository. You can record any number of changesets before pushing them to the main repo. In fact, you don't have to push them at all if you want to keep the changes only in your local repo. @@ -267,7 +283,7 @@ ssh-access, all you need to do is: If you use the -a flag to push, all local patches which are not in the main repo are pushed.

    - +

    Apply a patch from someone else

    Use: @@ -280,16 +296,16 @@ Use: This applies the patch to your local repository. To commit it to the main repo, use darcs push.

    - -

    Troubleshooting

    +

    Troubleshooting

    +

    I get the error "darcs not found" when pushing

    If you get darcs not found when you try to push your changes, you don't have darcs on your $PATH on the Chalmers system. See the section above on setting up your $PATH on the Chalmers system.

    - +

    I get the error "(sftp) failed to fetch files."

    There seems to be a problem with how darcs 1.0.4 calls sftp, which @@ -297,7 +313,7 @@ means that normal password authentication does not work. Either use Darcs 1.0.3 on your client, and be prepared to enter your password many times, or use the ssh ControlMaster feature as described above.

    - +

    I get the error "Not a repository: gfreposerver:..."

    You get this error when you have set up ControlMaster, but don't have a master @@ -315,14 +331,14 @@ run some program with outputs something once in a while, e.g.: $ ssh -M gfreposerver "bash -c 'while true; do echo -n .; sleep 30; done'"

    - -

    How do I avoid typing in my password so many times?

    +

    How do I avoid typing in my password so many times?

    +

    Using ssh ControlMaster

    See above.

    - +

    Using ssh-agent

    NOTE: the method below will not work with momo.medic.chalmers.se. @@ -385,7 +401,7 @@ Try to use it to log in (with your own username again): zsh:bringert:[~]>

    - +

    Further information about Darcs

    For more info about what you can do with darcs, see http://darcs.net/manual/ diff --git a/doc/darcs.txt b/doc/darcs.txt index e7dd26815..d9074dbbe 100644 --- a/doc/darcs.txt +++ b/doc/darcs.txt @@ -67,10 +67,23 @@ $ darcs pull -a Without ``-a``, you can choose which patches you want to get. +== Recording local changes == + +Since every copy is a repository, you can have local version control +of your changes. To record some changes, use: + +``` +$ darcs record +``` + +This creates a patch against the previous version and stores it in your +local repository. + == Submitting patches == If you are using read-only access, send your patches by email to -someone with write-access. Create the patch with: +someone with write-access. First record your changes in your local +repository, as described above. Then create the patch with: ``` $ darcs send -o mypatch.patch @@ -191,7 +204,7 @@ have to record the changes that you want to commit: $ darcs record ``` -This creates a patch against the previous version and stores it in you +This creates a patch against the previous version and stores it in your local repository. You can record any number of changesets before pushing them to the main repo. In fact, you don't have to push them at all if you want to keep the changes only in your local repo.