Updated man pages.

modulo-dm · Jun 20, 2017 · 6092555 · 6092555
1 parent 65525e1
commit 6092555
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 19 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" "January 2017" "Modulo" "Modulo manual"
+.TH "MODULO\-ADD" "1" "June 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,33 @@ modulo-add(1) -- Initialize a project for use with Modulo.
 ## SYNOPSIS
 
 `modulo add` [-u] <repo_url><br />
-`modulo add` --version [-u] <semver> <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 `--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
 
-* `--unmanaged`:
-    This informs modulo that the user will manage branches/commits/tags on their own.  When updating, only a pull from the remote is performed.
+* `--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.
@@ -36,18 +43,18 @@ No cloning of dependencies, etc. takes place here unless `--update` is specified
 
 ## 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 module is unmanaged, thus only doing a pull operation.<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" "January 2017" "Modulo" "Modulo manual"
+.TH "MODULO\-INIT" "1" "June 2017" "Modulo" "Modulo manual"
 .
 .SH "NAME"
 \fBmodulo\-init\fR \- Initialize a project for use with Modulo\.

diff --git a/Documentation/modulo-init.1.md b/Documentation/modulo-init.1.md
@@ -13,7 +13,7 @@ This command initializes a project/directory for use with Modulo.  A `.modulo` f
 ## OPTIONS
 
 * `--app`:
-    Initializes modulo as an application.  Any dependencies will be located in `.\modules` upon add/update.
+    Initializes modulo as an application.  Any dependencies will be located in `.\modules` upon add/update.  This option also adds an entry to SCM's ignore file to ignore the `modules` directory.
 
 * `--module`:
     Initializes modulo as an module.  Any dependencies will be located in `..\` upon add/update.

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" "January 2017" "Modulo" "Modulo manual"
+.TH "MODULO\-LAYOUT" "1" "June 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" "January 2017" "Modulo" "Modulo manual"
+.TH "MODULO\-UPDATE" "1" "June 2017" "Modulo" "Modulo manual"
 .
 .SH "NAME"
 \fBmodulo\-update\fR \- Update the project based on the current set of dependencies\.
@@ -42,6 +42,10 @@ This will iterate through all dependencies and perform an update\.
 Instructs Modulo to just perform an update on the specified dependency\. See \fBmap\fR for a list of dependencies\.
 .
 .TP
+\fB\-\-meh\fR
+Update will perform a no\-op if modulo isn\'t being used on this project\. Useful for build system integration\.
+.
+.TP
 \fB\-v, \-\-verbose\fR
 Prints verbose output\. Use this to see what underlying SCM commands are being used and any other important information\.
 .
@@ -56,4 +60,10 @@ modulo\-layout(1), modulo\-map(1)
 Report bugs to the Github Project located at https://github\.com/modulo\-dm/modulo/\. You\'ll be able to see the status and track any issues you create\.
 .
 .SH "AUTHORS"
-Brandon Sneed \fIbrandon@redf\.net\fR Peat Bakke \fIpeat@peat\.org\fR
+Brandon Sneed \fIbrandon@redf\.net\fR
+.
+.br
+Peat Bakke \fIpeat@peat\.org\fR
+.
+.br
+
diff --git a/Documentation/modulo-update.1.md b/Documentation/modulo-update.1.md
@@ -20,9 +20,12 @@ This command updates any previously specified dependencies.  Updates can consist
 * `--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.
 
+* `--meh`:
+Update will perform a no-op if modulo isn't being used on this project.  Useful for build system integration.
+
 * `-v, --verbose`:
 Prints verbose output.  Use this to see what underlying SCM commands are being used and any other important information.
 
@@ -39,7 +42,7 @@ Report bugs to the Github Project located at https://github.com/modulo-dm/modulo
 
 ## AUTHORS
 
-Brandon Sneed <brandon@redf.net>
-Peat Bakke <peat@peat.org>
+Brandon Sneed <brandon@redf.net><br />
+Peat Bakke <peat@peat.org><br />
 
 
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" "January 2017" "Modulo" "Modulo manual"
+.TH "MODULO" "1" "June 2017" "Modulo" "Modulo manual"
 .
 .SH "NAME"
 \fBmodulo\fR \- A source\-only dependency manager