Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

man pages - minor corrections #26

Merged
merged 1 commit into from
Mar 28, 2023
Merged

man pages - minor corrections #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/man/antler-proj.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ possible arguments
.PP
\f[B]init\f[R] command creates a new project.
Creating the directory tree, a \f[C]project.yaml\f[R] file and
initialize it.
initializes it.
.IP
.nf
\f[C]
Expand All @@ -46,7 +46,7 @@ Command arguments:
.PP
\f[B]Example: antler\-proj init ./project hello_world 0.1\f[R]
.PP
\f[B]add\f[R] command add an app, dependency, library or test to your
\f[B]add\f[R] command adds an app, dependency, library or test to your
project.
.IP
.nf
Expand Down Expand Up @@ -76,8 +76,8 @@ Command arguments:
.PP
\f[B]Example: antler\-proj update ./project app\f[R]
.PP
\f[B]remove\f[R] command remove an app, dependency, library or test to
your project.
\f[B]remove\f[R] command removes an app, dependency, library or test
from your project.
.IP
.nf
\f[C]
Expand All @@ -91,13 +91,13 @@ Command arguments:
.PP
\f[B]Example: antler\-proj remove ./project app\f[R]
.PP
\f[B]populate\f[R] command Load existing information about the project
starting from the root project.yaml file as it described in chapter
\f[B]populate\f[R] command loads existing information about the project
starting from the root project.yaml file as described in the chapter
\f[C]\[dq]Loading of a project\[dq]\f[R] in the User\[cq]s guide.
.IP
.nf
\f[C]
Without additional keys it pass through a subtree of each application and check all non local dependencies for updates.
Without additional keys it passes through a subtree of each application and checks all non\-local dependencies for updates.
Downloads all the updates in a way depending on where it is located.
\f[R]
.fi
Expand All @@ -120,8 +120,8 @@ that all data that describes the project is correct.
\f[C]
Check all project.yaml files described in the project for updates.
Download the updated project.yaml files.
Do all checks of the project as described in the user\[aq]s guide.
Checks if it is possible to access all dependencies. I.e. if all described local directories of all local dependencies
Perform all checks of the project as described in the user\[aq]s guide.
Check if it is possible to access all dependencies. I.e. if all described local directories of all local dependencies
exist and if it is possible to download all remote dependencies.
\f[R]
.fi
Expand All @@ -137,7 +137,7 @@ Command arguments:
.PP
\f[B]Example: antler\-proj validate ./project\f[R]
.PP
\f[B]build\f[R] command do building of all applications described in the
\f[B]build\f[R] command builds all applications described in the
project.yaml, their dependencies and tests.
.IP
.nf
Expand Down
16 changes: 8 additions & 8 deletions docs/man/antler-proj.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Each command has its own help which prints when the command runs with key --help

Below is described a full list of all possible commands and their possible arguments

**init** command creates a new project. Creating the directory tree, a `project.yaml` file and initialize it.
**init** command creates a new project. Creating the directory tree, a `project.yaml` file and initializes it.

```
Command arguments:
Expand All @@ -43,7 +43,7 @@ Command arguments:
**Example: antler-proj init ./project hello_world 0.1**


**add** command add an app, dependency, library or test to your project.
**add** command adds an app, dependency, library or test to your project.

```
Command arguments:
Expand All @@ -67,7 +67,7 @@ Command arguments:
**Example: antler-proj update ./project app**


**remove** command remove an app, dependency, library or test to your project.
**remove** command removes an app, dependency, library or test from your project.

```
Command arguments:
Expand All @@ -79,9 +79,9 @@ Command arguments:
**Example: antler-proj remove ./project app**


**populate** command Load existing information about the project starting from the root project.yaml file as it described in chapter `"Loading of a project"` in the User's guide.
**populate** command loads existing information about the project starting from the root project.yaml file as described in the chapter `"Loading of a project"` in the User's guide.

Without additional keys it pass through a subtree of each application and check all non local dependencies for updates.
Without additional keys it passes through a subtree of each application and checks all non-local dependencies for updates.
Downloads all the updates in a way depending on where it is located.

```
Expand All @@ -96,8 +96,8 @@ Command arguments:

Check all project.yaml files described in the project for updates.
Download the updated project.yaml files.
Do all checks of the project as described in the user's guide.
Checks if it is possible to access all dependencies. I.e. if all described local directories of all local dependencies
Perform all checks of the project as described in the user's guide.
Check if it is possible to access all dependencies. I.e. if all described local directories of all local dependencies
exist and if it is possible to download all remote dependencies.

```
Expand All @@ -108,7 +108,7 @@ Command arguments:
```
**Example: antler-proj validate ./project**

**build** command do building of all applications described in the project.yaml, their dependencies and tests.
**build** command builds all applications described in the project.yaml, their dependencies and tests.

```
Command arguments:
Expand Down