diff options
| author | Paul Cristian Sarbu <paul.cristian.sarbu@huawei.com> | 2025-06-25 16:06:36 +0200 |
|---|---|---|
| committer | Paul Cristian Sarbu <paul.cristian.sarbu@huawei.com> | 2025-06-25 16:44:08 +0200 |
| commit | a33f4193709da52f0abdd326162f87fdfab3ec8b (patch) | |
| tree | cabe69e7408e2e1573d5c975dbb4a3da9fb450bb | |
| parent | a8dbb39a6d8f18ce4e3516920b6cd7cce7ffce28 (diff) | |
| download | justbuild-a33f4193709da52f0abdd326162f87fdfab3ec8b.tar.gz | |
man pages: Improvements and typo fixes
| -rw-r--r-- | share/man/just-import-git.1.md | 2 | ||||
| -rw-r--r-- | share/man/just-lock.1.md | 18 |
2 files changed, 11 insertions, 9 deletions
diff --git a/share/man/just-import-git.1.md b/share/man/just-import-git.1.md index 83eb2e6e..a5e3de04 100644 --- a/share/man/just-import-git.1.md +++ b/share/man/just-import-git.1.md @@ -33,7 +33,7 @@ Only the main parts of repositories are imported (*`"repository"`*, *`"bindings"`*, names, and roots). The *`"pragma"`* part, as well as unknown fields are dropped. -The repository to import is specified by its URL +The repository to import is specified by its URL. The resulting configuration is printed on standard output. diff --git a/share/man/just-lock.1.md b/share/man/just-lock.1.md index 11bfadc6..97139594 100644 --- a/share/man/just-lock.1.md +++ b/share/man/just-lock.1.md @@ -15,24 +15,26 @@ DESCRIPTION Just-Lock is a tool that encompasses several functionalities related to generating and maintaining the **`just-mr-repository-config`**(5) of a Just -project. +project, centered around multi-repository configuration composition. The main functionality of the tool is to import declared dependencies from other Just projects and generate a repository configuration which can directly be used by **`just-mr`**(1). The imported repositories are renamed in a way that no conflicts arise and in a way to remind for which repositories they come as a -dependency. This extends thus the capabilities of existing tools such as -**`just-import-git`**(1) by implicitly allowing multiple imports to take place -and import sources other than Git repositories. +dependency. This mirrors the capabilities of existing tools such as +**`just-import-git`**(1) and extends them by features such as implicitly +allowing multiple imports to take place and supporting imports from sources +other than Git repositories (e.g., distfiles, local clones, repositories under +arbitrary version control systems). By default, the final configuration has the repositories deduplicated, by merging indistinguishable repositories, other than the `"main"` repository and -explicitly stated ones, to a single repository. This mirrors the capability -available standalone in **`just-deduplicate-repos`**(1). +explicitly stated ones, to a single entry. This mirrors the capability available +standalone in **`just-deduplicate-repos`**(1). The tool performs these operations based on a provided **`just-lock-config`**(5) -input file and outputs the resulting configuration file at either a given -provided location or at a location expected by **`just-mr`**(5). +input file and outputs the resulting configuration file at either an explicitly +given location or at a location expected by **`just-mr`**(5). OPTIONS ======= |