man: Section-5 man page for just-mrrc

1 files changed, 96 insertions, 0 deletions

diff --git a/share/man/just-mrrc.5.org b/share/man/just-mrrc.5.org
new file mode 100644
index 00000000..a3ee3d09
--- /dev/null
+++ b/share/man/just-mrrc.5.org
@@ -0,0 +1,96 @@
+#+TITLE: JUST-MRRC
+#+MAN_CLASS_OPTIONS: section-id=5
+
+* NAME
+
+just-mr configuration -- The format of the configuration used by *just-mr(1)*
+
+* DESCRIPTION
+
+The file is read as JSON. Any other serialization describing the
+same JSON object is equivalent. We assume, that in JSON objects,
+each key occurs at most once; it is implementation defined how
+repetitions of the same key are treated.
+
+** Location objects
+
+A /location/ is a JSON object with the keys ~"root"~, ~"path"~, and ~"base"~.
+
+The value for key ~"root"~ is either ~"workspace"~, ~"home"~, or ~"system"~,
+which have the following meanings:
+
+- ~"workspace"~ refers to the root of the workspace in which the ~just-mr~
+  invocation was issued (not the workspace of the requested main repository).
+  This location root is ignored if ~just-mr~ was not invoked from inside a
+  workspace.
+
+- ~"home"~ refers to the user's home directory.
+
+- ~"system"~ refers to the system root ~/~.
+
+The value for key ~"path"~ is the relative path of the item to locate within
+the location root.
+
+The value for key ~"base"~ is a relative path within the location root. This
+path is only relevant for locations of config files. If such a config file
+contains relative paths, those will be resolved relative to the specified base.
+If omitted, the default value ~.~ is used.
+
+** The just-mrrc format
+
+The just-mrrc is given by a JSON object.
+
+- The value for the key ~"config lookup order"~ is a JSON list of location
+  objects, specifying where to look for multi-repository configurations (see
+  *just-mr-repository-config(5)* for more detail). The lookup is performed in
+  the same order the location objects appear in the list.
+
+- The value for the key ~"local build root"~ is a single location object,
+  specifying the path to use as the local build root. For more details, see
+  *just-mr(1)*.
+
+- The value for the key ~"checkout locations"~ is a single location object,
+  specifying the path to the file for checkout locations. For more details, see
+  *just-mr(1)*.
+
+- The value for the key ~"distdirs"~ is a JSON list of location objects,
+  specifying where to look for distribution files (usually collected via the
+  subcommand ~fetch~). The lookup is performed in the same order the location
+  objects appear in the list. For more details, see *just-mr(1)*.
+
+- The value for the key ~"just"~ is a single location object, specifying the
+  path to the ~just~ binary to use for execution, if ~just-mr~ is used as a
+  launcher.
+
+- The value for the key ~"just args"~ is a JSON object. Its keys are ~just~
+  subcommands and its value is a JSON list of strings. For the corresponding
+  subcommand, these strings are prefixed to the ~just~ argument vector, if
+  ~just-mr~ is used as a launcher.
+
+* EXAMPLE
+
+An example just-mrrc file could look like the following:
+
+#+BEGIN_SRC js
+{ "config lookup order":
+  [ {"root": "workspace", "path": "repos.json"}
+  , {"root": "workspace", "path": "etc/repos.json"}
+  , {"root": "home", "path": ".just-repos.json"}
+  , {"root": "system", "path": "etc/just-repos.json"}
+  ]
+, "local build root": {"root": "home", "path": ".cache/just"}
+, "checkout locations": {"root": "home", "path": ".just-local.json"}
+, "distdirs": [{"root": "home", "path": ".distfiles"}]
+, "just": {"root": "system", "path": "usr/bin"}
+, "just args":
+  { "build": ["-r", "10.0.0.1:8980", "--remote-execution-property", "OS:Linux"]
+  , "install": ["-r", "10.0.0.1:8980", "--remote-execution-property", "OS:Linux"]
+  , "rebuild": ["-r", "10.0.0.1:8980", "--remote-execution-property", "OS:Linux"]
+  , "install-cas": ["-r", "10.0.0.1:8980"]
+  }
+}
+#+END_SRC
+
+* See also
+
+*just-mr(1)*, *just-mr-repository-config(5)*