README.md

   1 nailing-cargo
   2 =============
   3
   4 This is a wrapper tool for `cargo`, the Rust build tool and package
   5 manager.  Functions:
   6
   7  * Conveniently use local crates, including completely
   8    unpublished crates.
   9
  10  * Perform out-of-tree builds, including in an account with
  11    no write access to the source tree.
  12
  13  * Provide convenience aliases for target architecture names.
  14
  15  * Makes the default be offline (ie, not to access the internet)
  16
  17 These functions are of course configurable.
  18
  19 The primary source of information for `nailing-cargo` is the file
  20 `../Cargo.nail` (which is in TOML syntax).  You put `Cargo.nail`
  21 alongside the top-level git repositories you are working with, and
  22 invoke nailing-cargo from the git directory containing the Rust
  23 package you want to build.
  24
  25 Installing
  26 ----------
  27
  28 nailing-cargo is designed to be run out of a git clone:
  29
  30 ```
  31 $ git clone https://salsa.debian.org/iwj/nailing-cargo.git
  32 $ ln -s `pwd`/nailing-cargo/nailing-cargo ~/bin
  33 ```
  34
  35 It is self-contained, depending only on a reasonably functional Perl
  36 installation.
  37
  38 Most basic example usage
  39 ------------------------
  40
  41 ```
  42 $ cd myproject
  43 $ cat >../Cargo.nail
  44 subdirs="""
  45 myproject
  46 mylibrary
  47 """
  48 $ nailing-cargo cargo generate-lockfile
  49 $ nailing-cargo cargo build
  50 ```
  51
  52 Using local crates, or locally modified crates
  53 ==============================================
  54
  55 cargo does not work well with local crates,
  56 especially completely unpublished ones.
  57 (See [issue#6713](https://github.com/rust-lang/cargo/issues/6713),
  58 [stackoverflow](https://stackoverflow.com/questions/33025887/how-to-use-a-local-unpublished-crate),
  59 [issue#1481](https://github.com/rust-lang/cargo/issues/1481),
  60 [my blog](https://diziet.dreamwidth.org/1805.html).)
  61
  62 Using a local version of a crate should be possible without putting
  63 paths into your `Cargo.toml` and without editing complex
  64 configuration.
  65
  66 How nailing-cargo helps with using local crates
  67 -----------------------------------------------
  68
  69 nailing-cargo temporarily edits all the `Cargo.toml` files in all the
  70 subdirectories you mention, to refer to each other; then it runs
  71 cargo; and then it puts eveyrthing back.
  72
  73 Telling nailing-cargo how to massage Cargo.toml
  74 -----------------------------------------------
  75
  76 To find the subdirectories, and the packages, it looks for `subdirs`
  77 and `packages` in `Cargo.nail`.
  78
  79 `subdirs` can be a (usually multi-line) string containing a list of
  80 subdirectory names one per line.  (`#`-comments are supported.)  Or it
  81 can be a list of strings (`subdirs = ['myproject','mylibrary']`).  In
  82 each of these directories `Cargo.toml` will be massaged, and
  83 the package there will be used for other massaged `Cargo.toml`s
  84
  85 `packages` is a mapping from package names to dictionaries (e.g. in
  86 `Cargo.nail`, write something like: `[packages.mylibrary]`
  87 `subdir=mylibrary-test` or `[packages]` `mylibrary='mylibrary-test'`).
  88 These override the locations for the specified packages (so you can,
  89 for example, have multiple trees with the same package in).  The
  90 `subdir` values are also added to the list of directories where
  91 `Cargo.toml` should be massaged.
  92
  93 Out-of-tree builds
  94 ==================
  95
  96 It is often desirable to run builds in a way that does not write to
  97 the source tree.  cargo's enthusiastic approach to the dependency
  98 management task means that it is a good idea to try to insulate your
  99 main working environment from the many things cargo has decided to
 100 download and execute.
 101
 102 However, when you tell cargo to do an out of tree build (using
 103 `--manifest-path`) it will insist on `Cargo.lock` being in the source
 104 directory, and often will insist on writing to it.
 105
 106 How nailing-cargo helps with out-of-tree builds
 107 -----------------------------------------------
 108
 109 nailing-cargo (configured appropriately) copies files back and forth
 110 to between the source and build directories, and runs cargo as your
 111 build user.
 112
 113 The `Cargo.lock` must still be saved in your source tree somewhere.
 114 nailing-cargo arranges this for you.  You can either put this file in
 115 `.gitignore`; or commit it to git; or you can tell nailing-cargo to
 116 save it as something like `Cargo.lock.example`.
 117
 118 Configuring out-of-tree builds
 119 ------------------------------
 120
 121 To enable out-of-tree-builds, put an `[oot]` section in your
 122 `Cargo.nail` or one of nailing-cargo's other config files.
 123 In that section, specify at least `use`.
 124
 125 The primary config keys here are:
 126
 127   * `dir`: The build directory.  If relative, it is relative to the
 128    parent of the invocation directory (and could be a symlink then).
 129    Default is `Build` (assuming `use` is specified).
 130
 131   * `use`: How to become the build user.  Needs to be combined
 132     with other setting(s):
 133
 134     * `ssh`: Use ssh.  `user` must be given as well and is
 135        the `<user>@<host>` argument to ssh.
 136
 137     * `command_args`: `command` must be specified as a list,
 138        specifying a command and arguments which work like `nice`.
 139
 140     * `command_sh`: `command` must be specified as a list,
 141        specifying a command and arguments which work like `sh -c`.
 142
 143     * `null`: Run builds as the same user.
 144
 145     * `really`: Use `really` from `chiark-really.deb`.
 146        `user` must be given as well.
 147
 148 Target architecture convenience aliases
 149 =======================================
 150
 151 If you are cross-building you may need to tell cargo `--target=`.
 152 The architecture names are quite long and inconvenient.
 153
 154 A simple shell alias would help a lot, except that cargo rejects
 155 `--target=` when it thinks it's not needed.
 156
 157 In your nailing-cargo config, you can write soemthing like
 158 `arch.RPI='arm-unknown-linux-gnueabihf'`.  Then `nailing-cargo -ARPI`
 159 will DTRT.  In fact, you do not even need to specify that particular
 160 arch alias, since it is built-in to nailing-cargo.
 161
 162 Default change to offline mode
 163 ==============================
 164
 165 It seems to me that build tools should be explicit about their use of
 166 the network.  So by default, nailing-cargo passes `--offline` to
 167 cargo.
 168
 169 If you disagree with my opinion, write `misc.online=true` in your
 170 nailing-cargo configuration.  `misc.online=false`, and command line
 171 options, are also available, for overriding.
 172
 173 Command-line options
 174 ====================
 175
 176   * `-v`: Increase verbosity.  Default is 1.
 177
 178   * `-q`: Set verbosity ot 0.
 179
 180   * `-D`: Increase amount of debugging dump.
 181
 182   * `-n`: "No action": stop after writing Cargo.toml.nailing~
 183        everywhere, and do not run any build command.
 184
 185   * `-A<arch>` | `--arch=<arch>` | `--target=<arch>`
 186
 187        Specify target architecture.  If <arch> starts with a
 188        capital ascii letter, is an alias for some other arch
 189        looked up in Cargo.nail and then in the builtin list:
 190          RPI   arm-unknown-linux-gnueabihf
 191        Translates to a --target= option to the ultimate command,
 192        unless that is a cargo subcommand which would reject it.
 193        --arch and --target are simply aliases.
 194
 195   * `-u` | `--cargo-lock-update` | `-U` | `--no-cargo-lock-update`
 196
 197        Enables, or disables, the dance to allow Cargo.lock (or
 198        alternative) to be updated in the source directory.
 199
 200        With this dance enabled the Cargo.lock and Cargo.toml are
 201        copied to the build directory along with a skeleton just big
 202        enough to fool cargo.  After cargo has run, the resulting
 203        Cargo.lock is copied back to the source tree.
 204
 205        This makes no sense with in-tree builds.
 206
 207        Default is no update unless the ultimate command is a
 208        cargo subcommand which we know needs it.
 209
 210   * `-m` | `--cargo-manifest-args` | `-M` | `--no-cargo-manifest-args`
 211
 212        Controls whether we add cargo command line options relating to
 213        finding `Cargo.toml`, to the command to run.
 214
 215        Default is to add them iff we are doing an out-of-tree build,
 216        unless we are doing the dance to update the `Cargo.lock` (see
 217        above) in which case the only relevant files are to be found in
 218        the build directory).
 219
 220        The arguments added are
 221
 222            --manifest-path=<path/to/Cargo.toml>
 223            --locked
 224            --target-dir=target
 225
 226   * `-T` | `--no-cargo-target-dir-arg` | `-t` | `--cargo-target-dir-arg`
 227
 228        `-T` suppresses `--target-dir`; `-t` un-suppresses it.  Only
 229        makes any difference with `-m`, since otherwise no
 230        `--target-dir` would be passed anyway.  Additionally this is
 231        done automatically when nailing-cargo sees that the cargo
 232        subcommand is one which needs it, eg `fetch'.
 233
 234   * `-o` | `--online` | `--offline` | `-O`
 235
 236        Whether to allow cargo to make network access.  nailing-cargo
 237        always passes `--offline` to cargo, unless `--online` is in
 238        force.  The default is offline, unless the cargo subcommand is
 239        one which implies online (currently, `fetch').
 240
 241 Configuration
 242 =============
 243
 244 nailing-cargo reads these configuration files:
 245 ```
 246     /etc/nailing-cargo/cfg.toml
 247     ~/.nailing-cargo.toml
 248     ./.nailing-cargo.toml
 249     ../Nailing-Cargo.toml
 250     ../Cargo.nail
 251 ```
 252 Settings in later-mentioned files override ones in earlier-mentioned
 253 files.
 254
 255 Note that unlike everything else, `packages` and `subdirs` are read
 256 only from `Cargo.nail` (see "Limitations and bugs", below).
 257
 258 Alternative `Cargo.lock` filename
 259 ---------------------------------
 260
 261 To control use of alternative Cargo.lock filename, use the section
 262 `[alt_cargolock]`.  Settings here:
 263
 264   * `file = false`: disables this feature
 265
 266   * `file = true`: equivalent to `file = "Cargo.lock.example"`
 267
 268   * `file = <some leafname>`
 269
 270   * `force = false`: Use the alternative file only if it
 271      already exists.  (This is the default.)
 272
 273   * `force = true`: Always uses the alternative filename.
 274
 275 Running the command
 276 ===================
 277
 278 Normally you pass `cargo` as an argument to `nailing-cargo`.  But you
 279 can also pass `make` or any other command.  You may need to pass
 280 `--no-cargo-manifest-args` to nailing-cargo.
 281
 282 nailing-cargo passes these environment variables to the build command:
 283
 284   * `NAILINGCARGO_WORKSPHERE`: invocation `..` (parent)
 285   * `NAILINGCARGO_MANIFEST_DIR`: invocation `.` (invocation directory)
 286   * `NAILINGCARGO_BUILD_DIR`: build directory (even if same as source)
 287   * `NAILINGCARGO_BUILDSPHERE`: only set if out of tree: parent of build dir.
 288
 289 All of these are absolute paths.
 290
 291 Limitations and bugs
 292 ====================
 293
 294   * nailing-cargo dirties your source trees, including particularly
 295     `Cargo.toml` and `Cargo.lock`, temporarily.  If nailing-cargo crashes
 296     or is interrupted these changes may be left behind; running
 297     nailing-cargo again should clean up such a mess.  Unfortunately it is
 298     not possible to fix this bug because the cargo team have deliberately
 299     made cargo inflexible.
 300     [[issue#6715]](https://github.com/rust-lang/cargo/issues/6715).)
 301
 302   * Out of tree builds require a unified filesystem view: eg, different
 303     users on the same host, NFS, or something.  This could be improved.
 304
 305     The alternative Cargo.lock filename must currently be a leafname.  I
 306     think fixing this just involves review to check other values work
 307     properly.
 308
 309   * The alternative Cargo.lock file must be on smae filesystem.  This is
 310     not so easy to fix; we would want the existing algorithm but a
 311     fallback for this case.
 312
 313   * Cargo.nail is unconditionally looked for in `..`.  Ideally should be
 314     configurable, and also perhaps be able to combine multiple Cargo.nail
 315     files?  Relatedly, although nailing-cargo can read multiple config
 316     filos, it can only handle one file specifying directories and
 317     packages.
 318
 319   * Contributions to address these would be welcome, of course.  If you
 320     plan to do substantial work, please do get in touch with a sketch of
 321     your proposed changes.
 322
 323 Contributing and legal
 324 ======================
 325
 326 nailing-cargo is Free Software.
 327
 328 Please help improve it.  Contributions are welcome by email to
 329 `ijackson@chiark.greenend.org.uk` or via the
 330 [Salsa project](https://salsa.debian.org/iwj/nailing-cargo).
 331
 332 Legally, the project accepts contributions which follow the git commit
 333 Signed-off-by convention, by which the contributors certify their
 334 contributions according to the Developer Certificate of Origin version
 335 1.1 - see the file DEVELOPER-CERTIFICATE.
 336
 337 Copyright (C) 2019-2020 Ian Jackson and others
 338
 339 This program is free software: you can redistribute it and/or modify
 340 it under the terms of the GNU Affero General Public License as
 341 published by the Free Software Foundation, either version 3 of the
 342 License, or (at your option) any later version.
 343
 344 This program is distributed in the hope that it will be useful,
 345 but WITHOUT ANY WARRANTY; without even the implied warranty of
 346 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 347 GNU Affero General Public License for more details.
 348
 349 You should have received a copy of the GNU Affero General Public License
 350 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 351
 352 Individual files generally contain the following tag in the copyright
 353 notice, instead of the full licence grant text:
 354 ```
 355    SPDX-License-Identifier: AGPL-3.0-or-later
 356 ```
 357 As is conventional, this should be read as a licence grant.