Docs

Author: polytypic

commands/add

@@ -13,10 +13,8 @@ if [ "$#" -ne 3 ] || [ ! -d .git ] || [[ ! "$KIND" =~ ^(requires|equipment)$ ]];
 Usage: $CMD [requires|equipment] url branch
 
 Adds a new cppsm compatible submodule and recursively the submodules it requires
-to the project.
-
-This command is idempotent and can be run to e.g. add new transitive
-dependencies after updating submodules.
+to the project.  This command is idempotent and can be run to e.g. add new
+transitive dependencies after updating submodules.
 EOF
   exit 1
 fi

commands/init

@@ -9,9 +9,8 @@ if [ "$#" -ne 0 ] || [ ! -d .git ]; then
 Usage: $CMD
 
 Initializes a new C++ project with cppsm configuration files or updates an
-existing project to use the latest configuration files.
-
-Run $CMD in the top-level directory of a fresh git project.
+existing project to use the latest configuration files.  Run $CMD in the
+top-level directory of a fresh git project.
 EOF
   exit 1
 fi

commands/list

@@ -8,10 +8,8 @@ if [ "$#" -ne 0 ] || [ ! -e .gitmodules ] ; then
   cat << EOF
 Usage: $CMD
 
-Prints out a dependency tree of submodules.
-
-This command exits with an error code in case any problems are found in the
-dependency tree.
+Prints out a dependency tree of submodules.  This command exits with an error
+code in case any problems are found in the dependency tree.
 EOF
   exit 1
 fi

commands/remove

@@ -10,9 +10,8 @@ if [ "$#" -ne 1 ] || [ ! -d "$SUBMODULE" ] ; then
   cat << EOF
 Usage: $CMD path
 
-Removes a previously required submodule.
-
-Note that this command does remove submodules transitively.
+Removes a previously required submodule.  Note that this command does not remove
+submodules transitively.
 EOF
   exit 1
 fi

commands/upgrade

@@ -8,8 +8,8 @@ if [ "$#" -ne 0 ] || [ ! -e .gitmodules ] ; then
   cat << EOF
 Usage: $CMD
 
-Upgrades all cppsm managed submodules to latest remote versions and runs init to
-update configuration files.
+Upgrades all cppsm managed submodules to latest remote versions and runs cppsm
+init to update configuration files.
 EOF
   exit 1
 fi