{"header":{"message":"Document all available configuration options","description":"There were many undocumented options and it was quite unclear what the user could change without looking into the source code itself. Hopefully these changes should greatly simplify the configuration process!","timestamp":"2022-10-28T21:21:00.305478984Z","authors":[{}]},"hash":"DWUAKEQY5X223K5DZ34X2ADPGB3GEPIDIEAPHNPXFPCD7BBGXKKQC","authors":[{"login":"finchie","key":"6WCsL9cxQoPBLLwR1PUvmFBJi6wGTGFAxcxMovPQCwTZ"}],"deps":{"hashes":[["DWUAKEQY5X223K5DZ34X2ADPGB3GEPIDIEAPHNPXFPCD7BBGXKKQC","Document all available configuration options"],["AA",null],["NT22VBIWNZHOCIT4CUYOSC2KKGW5PC6OHPHFQAGQOGS4X5QKUTEQC","Add key and configuration info"]],"deps":["NT22VBIWNZHOCIT4CUYOSC2KKGW5PC6OHPHFQAGQOGS4X5QKUTEQC"],"known":[]},"hunks":[{"Replacement":{"inode":{"change":2,"pos":1963},"path":"src/configuration.md","line":7,"ins":{"up_context":[{"change":2,"pos":2133}],"down_context":[{"change":2,"pos":2679}],"flag":"BLOCK","start":0,"end":1990,"inode":{"change":2,"pos":1963}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":2133},"to":{"change":2,"start":2133,"end":2679},"introduced_by":2}],"inode":{"change":2,"pos":1963}},"ins_contents":[{"Add":"The location of Pijul's global configuration depends on the conventions of the user's operating system;"},{"Add":"Pijul will first try to instantiate a global configuration in the user's configuration directory according to"},{"Add":"[this table](https://docs.rs/dirs-next/2.0.0/dirs_next/fn.config_dir.html)."},{"Add":"If pijul cannot access the conventional config location, it will fall back to the"},{"Add":"[home directory](https://docs.rs/dirs-next/2.0.0/dirs_next/fn.home_dir.html), using `$HOME/.config/pijul`."},{"Add":"If that fails, `$HOME/.pijulconfig` will be tried as a last resort."},{"Add":""},{"Add":"### Global configuration data"},{"Add":""},{"Add":"Pijul supports the following global config values:"},{"Add":""},{"Add":"| Key | Description | Format |"},{"Add":"|--------------------|----------------------------------------------------------------|-------------------------------|"},{"Add":"| `colors` | If Pijul should display colorful output | [Choice](#choice) |"},{"Add":"| `pager` | If Pijul should use a pager (eg `less`) to display diff output | [Choice](#choice) |"},{"Add":"| `unrecord_changes` | How many changes to show when runnning `pijul unrecord` | Number |"},{"Add":"| `author` | Set the default author details | [Author](#author) |"},{"Add":"| `template` | Set a default template when using `pijul record` | [Template](#template) |"},{"Add":"| `ignore_kinds` | Set default ignore files when using `pijul init --kind=` | [Ignore kinds](#ignore-kinds) |"},{"Add":""},{"Add":"Here is an example of a fully-configured `config.toml`:"},{"Add":"```toml"},{"Add":"colors = \"always\""},{"Add":"pager = \"always\""},{"Add":"unrecord_changes = 1"},{"Add":""},{"Add":"[author]"},{"Add":"name = \"ferris\""},{"Add":"full_name = \"Ferris the Crab\""},{"Add":"email = \"ferris@example.com\""},{"Add":"key_path = \"/home/ferris/.ssh/id_ed25519.pub\""},{"Add":""},{"Add":"[template]"},{"Add":"message = \"/home/ferris/Documents/a_custom_message_for_me.txt\""},{"Add":"description = \"/home/ferris/Documents/a_custom_description_for_you.txt\""}],"del_contents":[{"Del":"The location of Pijul's global configuration depends on the conventions of the user's operating system; Pijul will first try to instantiate a global configuration in the user's congiruation directory according to [this table](https://docs.rs/dirs-next/2.0.0/dirs_next/fn.config_dir.html). If pijul cannot access the conventional config location, it will fall back to the [home directory](https://docs.rs/dirs-next/2.0.0/dirs_next/fn.home_dir.html), using `$HOME/.config/pijul`. If that fails, `$HOME/.pijulconfig` will be tried as a last resort.\n"}]}},{"Edit":{"inode":{"change":2,"pos":1963},"path":"src/configuration.md","line":43,"atom":{"NewVertex":{"up_context":[{"change":2,"pos":2680}],"down_context":[{"change":2,"pos":2680}],"flag":"BLOCK","start":1991,"end":2043,"inode":{"change":2,"pos":1963}}},"contents":[{"Add":"[ignore_kinds]"},{"Add":"rust = [ \"target\" ]"},{"Add":"```"},{"Add":""},{"Add":"#### Author"}]}},{"Edit":{"inode":{"change":2,"pos":1963},"path":"src/configuration.md","line":49,"atom":{"NewVertex":{"up_context":[{"change":2,"pos":2681}],"down_context":[{"change":2,"pos":2681}],"flag":"BLOCK","start":2044,"end":3055,"inode":{"change":2,"pos":1963}}},"contents":[{"Add":"You can give Pijul some basic information to identify yourself using any of the following fields:"},{"Add":"```toml"},{"Add":"[author]"},{"Add":"name = \"\""},{"Add":"full_name = \"\""},{"Add":"email = \"\""},{"Add":"key_path = \"\""},{"Add":"```"},{"Add":""},{"Add":"Unlike many other version control systems, Pijul does not permanently assign these details to changes."},{"Add":"For more information please reference [the section on keys](keys.md)."},{"Add":""},{"Add":"#### Template"},{"Add":""},{"Add":"If you have a file containing some default text,"},{"Add":"Pijul can automatically load those files into the relevant fields using the following configuration:"},{"Add":"```toml"},{"Add":"[template]"},{"Add":"message = \"\""},{"Add":"description = \"\""},{"Add":"```"},{"Add":""},{"Add":"#### Ignore Kinds"},{"Add":""},{"Add":"Pijul can be configured to automatically set up the [`.ignore` file](#ignore) when running `pijul init --kind `."},{"Add":"Here is an idea of what it might look like in practice:"},{"Add":"```toml"},{"Add":"[ignore_kinds]"},{"Add":"rust = [ \"target\", \"*.perf\" ]"},{"Add":"python = [ \"dist\", \"build\", \"eggs\" ]"},{"Add":"```"},{"Add":""}]}},{"Replacement":{"inode":{"change":2,"pos":1963},"path":"src/configuration.md","line":83,"ins":{"up_context":[{"change":2,"pos":2710}],"down_context":[{"change":2,"pos":2943}],"flag":"BLOCK","start":3056,"end":5403,"inode":{"change":2,"pos":1963}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":2710},"to":{"change":2,"start":2710,"end":2943},"introduced_by":2}],"inode":{"change":2,"pos":1963}},"ins_contents":[{"Add":"Users can take advantage of repository-specific configuration by editing the appropriate toml file: `/.pijul/config`."},{"Add":"Repository-specific configuration settings have a higher precedence than global configuration settings."},{"Add":"Pijul supports the following repository config values:"},{"Add":""},{"Add":"| Value | Description | Format |"},{"Add":"|----------------------|------------------------------------------------------------------|---------------------|"},{"Add":"| `colors` | If Pijul should display colorful output | [Choice](#choice) |"},{"Add":"| `pager` | If Pijul should use a pager (eg `less`) to display diff output | [Choice](#choice) |"},{"Add":"| `unrecord_changes` | How many changes to show when runnning `pijul unrecord` | Number |"},{"Add":"| `default_remote` | The default remote to interact with | String |"},{"Add":"| `extra_dependencies` | Extra changes that should always be depended upon | List[String] |"},{"Add":"| `remotes` | Named remotes that can be interacted with | [Remotes](#remotes) |"},{"Add":"| `hooks` | Hooks to run before recording a change | [Hooks](#hooks) |"},{"Add":""},{"Add":"Here is an example of a fully-configured `.pijul/config`:"},{"Add":"```toml"},{"Add":"colors = \"always\""},{"Add":"pager = \"always\""},{"Add":"unrecord_changes = 1"},{"Add":"default_remote = \"ferris@ssh.pijul.com:pijul/pijul\""},{"Add":"extra_dependencies = [ \"SXEYMYF7P4RZMZ46WPL4IZUTSQ2ATBWYZX7QNVMS3SGOYXYOHAGQC\" ]"},{"Add":""},{"Add":"[remotes]"},{"Add":"mirror = \"ferris@ssh.example.com:pijul/pijul\""},{"Add":""},{"Add":"[hooks]"},{"Add":"record = [ \"cargo fmt\" ]"},{"Add":"```"},{"Add":""},{"Add":"#### Remotes"},{"Add":""},{"Add":"A remote is simply a named URL of a Pijul repository."},{"Add":"For more information please reference [pijul remote](reference/remote.md)."},{"Add":""},{"Add":"#### Hooks"},{"Add":""},{"Add":"A hook is a script run in the default shell before a command is executed."},{"Add":"Currently only `pijul record` is supported."},{"Add":"Here is an example:"},{"Add":"```toml"},{"Add":"[hooks]"},{"Add":"record = [ \"cargo fmt\" ]"},{"Add":"```"},{"Add":""},{"Add":"## Choice"},{"Add":""},{"Add":"A choice in Pijul can have 3 possible values:"},{"Add":"1. `auto`"},{"Add":"2. `always`"},{"Add":"3. `never`"},{"Add":""},{"Add":"When no value is supplied, this will default to `auto`."},{"Add":"In that case, Pijul will automatically determine which choice to pick."},{"Add":"For example, if your global configuration contains `colors = \"auto\"`, Pijul automatically use colored output when appropriate."}],"del_contents":[{"Del":"Users can take advantage of repository-specific configuration by editing the appropriate toml file: `/.pijul/config.toml`. Repository-specific configuration settings have a higher precedence than global configuration settings.\n"}]}},{"Replacement":{"inode":{"change":2,"pos":1963},"path":"src/configuration.md","line":140,"ins":{"up_context":[{"change":2,"pos":2955}],"down_context":[],"flag":"BLOCK","start":5404,"end":5538,"inode":{"change":2,"pos":1963}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":2955},"to":{"change":2,"start":2955,"end":3089},"introduced_by":2}],"inode":{"change":2,"pos":1963}},"ins_contents":[{"Add":"Items in a repository can be ignored by editing a repository's `.ignore` file."},{"Add":"Pijul supports standard glob syntax in `.ignore` files."}],"del_contents":[{"Del":"Items in a repository can be ignored by editing a repository's `.ignore` file. Pijul supports standard glob syntax in `.ignore` files."}]}}],"owner":"pijul","repo":"manual","token":"gQenQ+1UTcxOzmKfLOT7O9hOxfzeqMR93Ev/8WNkA4M=","login":null}

…

Dependencies

Change contents