From: Ian Jackson Date: Fri, 19 Jun 2020 12:42:55 +0000 (+0100) Subject: README.md: Config reference tidying X-Git-Tag: nailing-cargo/1.0.0~140 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=3c9ce9c2158baf05c9324c085db8811439c9af41;p=nailing-cargo.git README.md: Config reference tidying Signed-off-by: Ian Jackson --- diff --git a/README.md b/README.md index 8996a66..97ff6f1 100644 --- a/README.md +++ b/README.md @@ -241,8 +241,9 @@ files. Source directories and packages (toplevel) ------------------------------------------ -Note that unlike everything else, these keys `packages` and `subdirs` -are read only from `Cargo.nail` (see "Limitations and bugs", below). +Note that unlike everything else, these keys (`packages` and +`subdirs`) are read only from `Cargo.nail` (see "Limitations and +bugs", below). These keys specify a combination of (i) a mapping from package name to source subdirectory (ii) a set of subdirectories whose `Cargo.toml` @@ -262,9 +263,9 @@ must be massaged. * `subdirs`: a list of subdirectory names to process. - Each subdirectory's `Cargo.toml` will be massaged; also, the - subdirectory will be examined to see what package it contains and - it will be used as the source for that package, unless that + Each subdirectory's `Cargo.toml` will be massaged. Also, the + subdirectory will be examined to see what package it contains; it + will then be used as the source for that package, unless that package appears in an entry in `packages`, or an earlier entry in `subdirs`. @@ -272,7 +273,7 @@ must be massaged. ['myproject','mylibrary']`). Or it can be single multi-line string containing one subdirectory name per line; in that case, `#`-comments are supported and tabs and spaces are ignored - (See "Most basic example usage" above.) + (see "Most basic example usage" above.) In each case the subdirectory should usually be a relative pathname; it is relative to the directory containing `Cargo.nail`.