Updated documentation.

modulo-dm · Jul 11, 2017 · 5607619 · 5607619
1 parent e717c53
commit 5607619
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 21 deletions.
diff --git a/Documentation/modulo-add.1 b/Documentation/modulo-add.1
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "MODULO\-ADD" "1" "June 2017" "Modulo" "Modulo manual"
+.TH "MODULO\-ADD" "1" "July 2017" "Modulo" "Modulo manual"
 .
 .SH "NAME"
 \fBmodulo\-add\fR \- Initialize a project for use with Modulo\.

diff --git a/Documentation/modulo-add.1.md b/Documentation/modulo-add.1.md
@@ -4,26 +4,34 @@ modulo-add(1) -- Initialize a project for use with Modulo.
 ## SYNOPSIS
 
 `modulo add` [-u] <repo_url><br />
-`modulo add` --version <semver> [-u] <repo_url><br />
-`modulo add` --unmanaged [-u] <repo_url><br />
+`modulo add` --tag [-u] <semver> <repo_url><br />
+`modulo add` --branch [-u] <branchname> <repo_url><br />
+`modulo add` --commit [-u] <commithash> <repo_url><br />
 
 ## DESCRIPTION
 
-This command adds a dependency to the current project.
+This command adds a dependency to the current project.  When no tag/branch/commit is specified, `origin/master` is assumed.
 
-No cloning of dependencies, etc. takes place here unless `-u, --update` is specified.
+No cloning of dependencies, etc. takes place here unless `--update` is specified.
 
 Any dependencies that are cloned (even branches) are in a detached-head state.  This forces the same workflow to be used regardless of the checkout type.
 
 ## OPTIONS
 
-* `--version` <semver>:
+* `--tag` <semver>:
     This option specifies that a semver tag or range should be checked out.  Modulo treats semver as `breaking.feature.fix` since that is more meaningful to most.
 
     Modulo's semver implementation follows the `npm` implementation very closely.  To read more, visit:
 
     https://docs.npmjs.com/getting-started/semantic-versioning
 
+* `--branch` <branchname>:
+    Specify the branch desired on  checkedout.
+    It's preferrable to specify the remote, ie: `origin/mybranch`.  If omitted, `origin` will be the assumed remote.'
+
+* `--commit` <commithash>:
+    Specify the commit hash to be used on checkout.  This accepts both short and long hashes.
+
 * `-u, --update`:
     Immediately perform an `update` after adding the dependency.  This will clone if necessary, as well as perform any dependency compatibility checks.
 
@@ -35,18 +43,18 @@ Any dependencies that are cloned (even branches) are in a detached-head state.
 
 ## EXAMPLES
 
-`modulo add --version ">=1.1 < 2.0.0" --update git@github.com/something/yadda.git`
+`modulo add --tag ">=1.1 < 2.0.0" --update git@github.com/something/yadda.git`
 
 This will do the following<br />
 *   Add yadda.git as a dependency.<br />
 *   Clone yadda.git, because --update was specified.<br />
 *   Checkout the latest tag that is greater than or equal to 1.1.0, but less than 2.0.0<br />
 
-`modulo add --unmanaged git@github.com/something/yadda.git`
+`modulo add --branch master git@github.com/something/yadda.git`
 
 This will<br />
 *   Add yadda.git as a dependency.<br />
-*   Record that when performing update, this dependency is to be unmanaged.  Only a pull will be performed.<br />
+*   Record that when performing update, the branch `origin/master` is to be checked out.<br />
 
 ## SEE ALSO
 

diff --git a/Documentation/modulo-init.1 b/Documentation/modulo-init.1
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "MODULO\-INIT" "1" "June 2017" "Modulo" "Modulo manual"
+.TH "MODULO\-INIT" "1" "July 2017" "Modulo" "Modulo manual"
 .
 .SH "NAME"
 \fBmodulo\-init\fR \- Initialize a project for use with Modulo\.

diff --git a/Documentation/modulo-layout.1 b/Documentation/modulo-layout.1
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "MODULO\-LAYOUT" "1" "June 2017" "Modulo" "Modulo manual"
+.TH "MODULO\-LAYOUT" "1" "July 2017" "Modulo" "Modulo manual"
 .
 .SH "NAME"
 \fBmodulo\-layout\fR \- Explains the file system layout

diff --git a/Documentation/modulo-update.1 b/Documentation/modulo-update.1
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "MODULO\-UPDATE" "1" "June 2017" "Modulo" "Modulo manual"
+.TH "MODULO\-UPDATE" "1" "July 2017" "Modulo" "Modulo manual"
 .
 .SH "NAME"
 \fBmodulo\-update\fR \- Update the project based on the current set of dependencies\.
@@ -34,14 +34,22 @@ Checking out the specified tag/branch/commit for each dependency\.
 .SH "OPTIONS"
 .
 .TP
-\fB\-\-all\fR
+\fB\-a, \-\-all\fR
 This will iterate through all dependencies and perform an update\.
 .
 .TP
 \fIdependencyname\fR
 Instructs Modulo to just perform an update on the specified dependency\. See \fBmap\fR for a list of dependencies\.
 .
 .TP
+`\-\-nonzero
+Returns a non\-zero result if modulo actually cloned dependencies\. This is useful for CI build systems\.
+.
+.TP
+\fB\-\-host <host name>\fR
+Checks for ability to connect to host name before continuing\. This allows for developers to work off\-line without being interrupted\.
+.
+.TP
 \fB\-\-meh\fR
 Update will perform a no\-op if modulo isn\'t being used on this project\. Useful for build system integration\.
 .

diff --git a/Documentation/modulo-update.1.md b/Documentation/modulo-update.1.md
@@ -11,19 +11,24 @@ modulo-update(1) -- Update the project based on the current set of dependencies.
 This command updates any previously specified dependencies.  Updates can consist of the following:
 
 * Cloning any dependencies that don't exist in the filesystem yet.
-* Performing a fetch on dependencies to get any new tags/branches/commits.
-* Verifying that it's safe to check out the specified version.
-* Checking out the specified version for each dependency.
-* Dependencies marked as unmanaged will simply perform a pull.
+* Performing a fetch on dependencies to get any new tags/branches/commits
+* Verifying that it's safe to check out the specified tag/branch/commit.
+* Checking out the specified tag/branch/commit for each dependency.
 
 ## OPTIONS
 
-* `--all`:
+* `-a, --all`:
 This will iterate through all dependencies and perform an update.
 
-* `<dependencyname>`:
+* <dependencyname>:
 Instructs Modulo to just perform an update on the specified dependency.  See `map` for a list of dependencies.
 
+* `--nonzero:
+Returns a non-zero result if modulo actually cloned dependencies.  This is useful for CI build systems.
+
+* `--host <host name>`:
+Checks for ability to connect to host name before continuing.  This allows for developers to work off-line without being interrupted.
+
 * `--meh`:
 Update will perform a no-op if modulo isn't being used on this project.  Useful for build system integration.
 

diff --git a/Documentation/modulo-update.1.ronn b/Documentation/modulo-update.1.ronn
@@ -17,12 +17,18 @@ This command updates any previously specified dependencies.  Updates can consist
 
 ## OPTIONS
 
-* `--all`:
+* `-a, --all`:
 This will iterate through all dependencies and perform an update.
 
 * <dependencyname>:
 Instructs Modulo to just perform an update on the specified dependency.  See `map` for a list of dependencies.
 
+* `--nonzero:
+Returns a non-zero result if modulo actually cloned dependencies.  This is useful for CI build systems.
+
+* `--host <host name>`:
+Checks for ability to connect to host name before continuing.  This allows for developers to work off-line without being interrupted.
+
 * `--meh`:
 Update will perform a no-op if modulo isn't being used on this project.  Useful for build system integration.
 

diff --git a/Documentation/modulo.1 b/Documentation/modulo.1
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "MODULO" "1" "June 2017" "Modulo" "Modulo manual"
+.TH "MODULO" "1" "July 2017" "Modulo" "Modulo manual"
 .
 .SH "NAME"
 \fBmodulo\fR \- A source\-only dependency manager