Fix some mistakes in the docs

[?]
Nov 26, 2020, 5:36 PM
4H2XTVJ2BNXDNHQ3RQTMOG3I4NRGZT7JDLC2GRINS56TIYTYTO4QC

Dependencies

  • [2] TZVUNELW Documentation comments
  • [3] AEPEFS7O Write help for each argument
  • [4] VQPAUKBQ channel switch as an alias to reset
  • [5] L4JXJHWX pijul/*: reorganize imports and remove extern crate
  • [6] 5HF7C67M push/pull: fixed "changes" arguments
  • [7] 23LVKATN Use pager crate for log output
  • [8] SXEYMYF7 Fixing the bad changes in history (unfortunately, by rebooting).
  • [9] VZL5OHF5 Remove the obsolete `remote list` command
  • [10] Q4SVMHAE Removing --channel from the changes command

Change contents

  • replacement in pijul/src/commands/upgrade.rs at line 11
    [4.93671][3.0:149]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.93671]
    [4.93671]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/unrecord.rs at line 10
    [4.95831][3.150:299]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.95831]
    [4.95831]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/reset.rs at line 11
    [4.97841][3.474:623]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.97841]
    [4.97841]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/reset.rs at line 17
    [4.360][3.672:769]()
    /// Print what changes would take place in the wroking copy, without actually doing anything
    [4.360]
    [4.97965]
    /// Print this file to the standard output
  • replacement in pijul/src/commands/reset.rs at line 20
    [4.384][3.770:816]()
    /// Reset the working copy to this change
    [4.384]
    [4.98014]
    /// Apply these changes to the working copy after switching to
    /// thid channel, but do not touch the prestine
  • replacement in pijul/src/commands/record.rs at line 21
    [4.102194][3.893:938]()
    /// Set the change message to this value
    [4.102194]
    [4.102194]
    /// Set the change message
  • replacement in pijul/src/commands/record.rs at line 24
    [4.102270][3.939:982]()
    /// Set the author field to this value
    [4.102270]
    [4.102270]
    /// Set the author field
  • replacement in pijul/src/commands/record.rs at line 30
    [4.102394][3.1057:1206]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.102394]
    [4.102394]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/record.rs at line 33
    [4.102463][3.1207:1253]()
    /// Set the timestamp field to this value
    [4.102463]
    [4.102463]
    /// Set the timestamp field
  • replacement in pijul/src/commands/record.rs at line 36
    [4.102527][3.1254:1289]()
    /// Sign the change with a key
    [4.102527]
    [4.102527]
    /// Sign the change with the default key
  • edit in pijul/src/commands/record.rs at line 39
    [4.102572][4.102572:102621]()
    #[clap(long = "stdin")]
    pub stdin: bool,
  • edit in pijul/src/commands/record.rs at line 44
    [4.102725]
    [4.102725]
    /// Paths in which to record the changes
  • replacement in pijul/src/commands/pushpull.rs at line 17
    [4.111977][3.1350:1499]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.111977]
    [4.111977]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/pushpull.rs at line 56
    [4.113077][3.1528:1614]()
    /// Path to the repository. Uses the current repository if the argument is omited
    [4.113077]
    [4.113077]
    /// Path to the repository. Uses the current repository if the argument is omitted
  • replacement in pijul/src/commands/pushpull.rs at line 65
    [4.113241][3.1704:1742]()
    /// Do not check for certificates
    [4.113241]
    [3.1742]
    /// Do not check certificates (HTTPS remotes only, this option might be dangerous)
  • replacement in pijul/src/commands/pushpull.rs at line 68
    [4.113328][3.1768:1798]()
    /// Push only these paths
    [4.113328]
    [4.113380]
    /// Push changes only relating to these paths
  • replacement in pijul/src/commands/pushpull.rs at line 73
    [4.113458][3.1828:1895]()
    /// Push to this remote channel instead of the default channel
    [4.113458]
    [4.113458]
    /// Push to this remote channel instead of the remote's default channel
  • replacement in pijul/src/commands/pushpull.rs at line 83
    [4.113567][3.1954:2103]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.113567]
    [4.113567]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/pushpull.rs at line 92
    [4.113745][3.2193:2231]()
    /// Do not check for certificates
    [4.113745]
    [3.2231]
    /// Do not check certificates (HTTPS remotes only, this option might be dangerous)
  • replacement in pijul/src/commands/pushpull.rs at line 106
    [4.371][3.2444:2523]()
    /// Pull changes from the local repository, not necessorily from a channel
    [4.371]
    [3.2523]
    /// Pull changes from the local repository, not necessarily from a channel
  • edit in pijul/src/commands/protocol.rs at line 15
    [4.123611]
    [4.123611]
    /// This command is not meant to be run by the user,
    /// instead it is called over SSH
  • replacement in pijul/src/commands/protocol.rs at line 19
    [4.123656][3.2549:2698]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.123656]
    [4.123656]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/log.rs at line 13
    [4.134600][3.2734:2883]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.134600]
    [4.134600]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/log.rs at line 22
    [4.134777][3.2988:3020]()
    /// Show logs of the states
    [4.134777]
    [4.134777]
    /// Include state identifiers in the log output
  • replacement in pijul/src/commands/log.rs at line 25
    [4.134823][3.3021:3050]()
    /// Show the description
    [4.134823]
    [4.134823]
    /// Include full change discription in the log output
  • replacement in pijul/src/commands/fork.rs at line 10
    [4.168042][3.3179:3328]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.168042]
    [4.168042]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/fork.rs at line 16
    [4.168193][3.3408:3476]()
    /// Make channel from this change, instead of the latest change
    [4.168193]
    [4.168193]
    /// Apply this change after creating the channel
  • replacement in pijul/src/commands/file_operations.rs at line 11
    [4.169248][3.3514:3663]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.169248]
    [4.169248]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/file_operations.rs at line 68
    [4.170782][3.3789:3938]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.170782]
    [4.170782]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/file_operations.rs at line 87
    [4.171231][2.181:330]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.171231]
    [4.171231]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/file_operations.rs at line 132
    [4.172540][3.3939:4088]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.172540]
    [4.172540]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • edit in pijul/src/commands/debug.rs at line 10
    [4.177879][3.4127:4276]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • edit in pijul/src/commands/debug.rs at line 12
    [4.177944][3.4277:4302]()
    /// Use this channel
  • replacement in pijul/src/commands/credit.rs at line 14
    [4.178973][3.4303:4452]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.178973]
    [4.178973]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/credit.rs at line 20
    [4.179097][3.4510:4551]()
    /// The file to show the annotations
    [4.179097]
    [4.179097]
    /// The file to annotate
  • replacement in pijul/src/commands/clone.rs at line 20
    [4.183451][3.4835:4860]()
    /// Close this state
    [4.183451]
    [3.4860]
    /// clone this state
  • replacement in pijul/src/commands/clone.rs at line 23
    [4.183561][3.4916:4940]()
    /// Clone this path
    [4.183561]
    [3.4940]
    /// Clone this path only
  • replacement in pijul/src/commands/clone.rs at line 26
    [4.183663][3.4984:5018]()
    /// Do not check certificates
    [4.183663]
    [3.5018]
    /// Do not check certificates (HTTPS remotes only, this option might be dangerous)
  • replacement in pijul/src/commands/clone.rs at line 31
    [4.183770][3.5071:5114]()
    /// Path where to clone the repositoru
    [4.183770]
    [3.5114]
    /// Path where to clone the repository
  • replacement in pijul/src/commands/channel.rs at line 10
    [4.187058][3.5180:5329]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.187058]
    [4.187058]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/archive.rs at line 11
    [4.191291][3.5330:5479]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.191291]
    [4.191291]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/archive.rs at line 14
    [4.191356][3.5480:5537]()
    /// Use this channel, instead of the current channe;
    [4.191356]
    [4.191356]
    /// Use this channel, instead of the current channel
  • replacement in pijul/src/commands/archive.rs at line 17
    [4.191415][3.5538:5590]()
    /// Clone this remote and make an archive of it
    [4.191415]
    [4.191415]
    /// Ask the remote to send an archive
  • replacement in pijul/src/commands/archive.rs at line 20
    [4.191472][3.5591:5625]()
    /// Do not check certificates
    [4.191472]
    [3.5625]
    /// Do not check certificates (HTTPS remotes only, this option might be dangerous)
  • replacement in pijul/src/commands/archive.rs at line 26
    [4.191614][3.5682:5715]()
    /// Archive upto this change
    [4.191614]
    [4.191614]
    /// Apply these changes after switching to the channel
  • replacement in pijul/src/commands/archive.rs at line 29
    [4.191685][3.5716:5761]()
    /// Use this prefix, before the filename
    [4.191685]
    [4.191685]
    /// Append this path in front of each path inside the archive
  • replacement in pijul/src/commands/apply.rs at line 12
    [4.194540][3.5795:5944]()
    /// Set the repository in which paths must be added. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
    [4.194540]
    [4.194540]
    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.
  • replacement in pijul/src/commands/apply.rs at line 15
    [4.194605][3.5945:5984]()
    /// Apply change from this channel
    [4.194605]
    [4.194605]
    /// Apply change to this channel