pijul/pijul - Change KWAMD2KR5UYRHHPZWL7GY2KQKNXNVS4BYBVK3FXDI23NQMWA3U4QC

A few fixes in the documentation comments

Created by pmeunier on November 26, 2020

KWAMD2KR5UYRHHPZWL7GY2KQKNXNVS4BYBVK3FXDI23NQMWA3U4QC

Dependencies

In channels

main

In discussions

#214 Minor cleanup

#219 Minor cleanup, redux

#243 Better Remotes

#143 Clippy Lints

Change contents

Replacement in pijul/src/commands/upgrade.rs at line 12 [5.93400]

B:BD[5.93671] → [4.0:149]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 11 [5.95630]

B:BD[5.95831] → [4.150:299]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 12 [5.97650]

B:BD[5.97841] → [4.300:449]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 15 [5.97650]

B:BD[6.326] → [7.624:671]

    /// Reset the working copy to thid channel

[6.326]

[5.97906]

    /// Reset the working copy to this channel, and change the current channel to this channel.

Replacement in pijul/src/commands/reset.rs at line 18 [5.97650]

B:BD[6.360] → [4.450:497]

    /// Print this file to the standard output

[6.360]

[5.97965]

    /// Print this file to the standard output, without modifying the repository (works for a single file only).

Deletion in pijul/src/commands/reset.rs at line 21 [5.97650]
B:BD[6.384] → [4.498:566]
B:BD[4.566] → [4.566:618]
∅:D[4.618] → [5.98014:98043]
∅:D[6.384] → [5.98014:98043]
∅:D[7.816] → [5.98014:98043]
B:BD[5.98014] → [5.98014:98043]
B:BD[5.98043] → [6.385:417]
```
    /// Apply these changes to the working copy after switching to 
    /// thid channel, but do not touch the prestine
    #[clap(long = "change")]
    pub change: Option<String>,
```

Deletion in pijul/src/commands/reset.rs at line 41 [5.97650]

B:BD[5.98558] → [2.0:93]

∅:D[2.93] → [5.98600:98655]

B:BD[5.98600] → [5.98600:98655]

        } else if let Some(ref chg) = self.change {
            txn.hash_from_prefix(&chg)?;
            txn.open_or_create_channel(&channel_name)?

Deletion in pijul/src/commands/reset.rs at line 99 [5.97650]

B:BD[5.100716] → [5.100716:100907]

            if let Some(ch) = self.change {
                let (hash, _) = txn.hash_from_prefix(&ch)?;
                txn.apply_change_rec(&repo.changes, &mut channel, hash)?
            }

Replacement in pijul/src/commands/record.rs at line 31 [5.101759]

B:BD[5.102394] → [4.681:830]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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/pushpull.rs at line 18 [5.111631]

B:BD[5.111977] → [4.956:1105]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 84 [5.111631]

B:BD[5.113567] → [4.1410:1559]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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/protocol.rs at line 20 [5.123281]

B:BD[5.123656] → [4.1816:1965]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 14 [5.134376]

B:BD[5.134600] → [4.1966:2115]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 23 [5.134376]
B:BD[5.134777] → [4.2116:2168]
```
    /// Include state identifiers in the log output
```
[5.134777]
[5.134777]
```
    /// Include state identifiers in the output
```

Replacement in pijul/src/commands/log.rs at line 26 [5.134376]

B:BD[5.134823] → [4.2169:2227]

    /// Include full change discription in the log output

[5.134823]

    /// Include full change description in the output

Replacement in pijul/src/commands/init.rs at line 10 [5.136543]

B:BD[5.136669] → [7.3051:3122]

    /// Initialize repository with this channel as the default channel

[5.136669]

    /// Set the name of the current channel (defaults to "main").

Replacement in pijul/src/commands/git.rs at line 17 [5.137210]

B:BD[5.137477] → [5.137477:137505]

    #[clap(long = "stats")]

[5.137477]

[5.137505]

    /// Process this path instead of the current directory, creating a Pijul repository if necessary.
    pub repo_path: Option<PathBuf>,
    /// Time the import, and output values to this file.
    #[clap(long = "stats", setting = AppSettings::Hidden)]

Replacement in pijul/src/commands/git.rs at line 22 [5.137210]

B:BD[5.137533] → [5.137533:137602]

    pub repo_path: Option<PathBuf>,
    #[clap(default_value = "0")]

[5.137533]

[5.137602]

    /// Check only the first n commits processed.
    #[clap(default_value = "0", setting = AppSettings::Hidden)]

Replacement in pijul/src/commands/fork.rs at line 11 [5.167873]

B:BD[5.168042] → [4.2228:2377]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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/file_operations.rs at line 12 [5.169058]

B:BD[5.169248] → [4.2432:2581]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 69 [5.169058]

B:BD[5.170782] → [4.2582:2731]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 88 [5.169058]

B:BD[5.171231] → [4.2732:2881]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 133 [5.169058]

B:BD[5.172540] → [4.2882:3031]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.172540]

    /// Set the repository where this command should run. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

Insertion in pijul/src/commands/diff.rs at line 15 [5.173551]

[5.173780]

    /// Set the repository where this command should run. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

Insertion in pijul/src/commands/diff.rs at line 18 [5.173551]

[5.173849]

    /// Output the diff in JSON format instead of the default change text format.

Insertion in pijul/src/commands/diff.rs at line 21 [5.173551]
[5.173896]
[5.173896]
```
    /// Compare with this channel.
```

Insertion in pijul/src/commands/diff.rs at line 24 [5.173551]

[5.173959]

    /// Add all the changes of this channel as dependencies (except changes implied transitively), instead of the minimal dependencies.

Insertion in pijul/src/commands/diff.rs at line 27 [5.173551]
[5.174004]
[3.0]
```
    /// Show a short version of the diff.
```

Insertion in pijul/src/commands/diff.rs at line 30 [5.173551]

[3.49]

[5.174004]

    /// Only diff those paths (files or directories). If missing, diff the entire repository.

Replacement in pijul/src/commands/credit.rs at line 15 [5.178684]

B:BD[5.178973] → [4.3032:3181]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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/clone.rs at line 21 [5.182891]
B:BD[5.183451] → [4.3212:3237]
```
    /// clone this state
```
[5.183451]
[7.4860]
```
    /// Clone this state
```

Replacement in pijul/src/commands/clone.rs at line 32 [5.182891]

B:BD[5.183770] → [4.3356:3399]

∅:D[4.3399] → [7.5114:5179]

B:BD[7.5114] → [7.5114:5179]

    /// Path where to clone the repository
    /// If not given, the name of the remote repsoitory is given

[5.183770]

    /// Path where to clone the repository.
    /// If missing, the inferred name of the remote repository is used.

Replacement in pijul/src/commands/channel.rs at line 11 [5.186892]

B:BD[5.187058] → [4.3400:3549]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.187058]

    /// Set the repository where this command should run. Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

Deletion in pijul/src/commands/channel.rs at line 66 [5.186892]
B:BD[6.1624] → [6.1624:1658]
```
                    change: None,
```

Replacement in pijul/src/commands/archive.rs at line 12 [5.191083]

B:BD[5.191291] → [4.3550:3699]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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/apply.rs at line 13 [5.194289]

B:BD[5.194540] → [4.4016:4165]

    /// Set the repository where this command should run Defaults to the first ancestor of the current directory that contains a `.pijul` directory.

[5.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 19 [5.194289]

B:BD[5.194664] → [7.5985:6036]

    /// Only apply the dependencies of this change

[5.194664]

    /// Only apply the dependencies of this change, not the change itself.

Replacement in pijul/src/commands/apply.rs at line 22 [5.194289]

B:BD[5.194717] → [7.6037:6080]

    /// The change that need to be applied

[5.194717]

    /// The change that need to be applied. If this value is missing, read the change in text format on the standard input.