{"header":{"message":"first","description":null,"timestamp":"2021-09-13T21:46:48.402917Z","authors":[{}]},"hash":"XRLPZVCTDGM6JC7IZTA3CSSKJ2MHUHMKOR6JHMNUXMSXC7MD6AZAC","authors":[{"login":"ammkrn","key":"8pRcgpBDWybJEh4eZbHW8iV75uVLVJ5dkoYnwL7kkMgE"}],"deps":{"hashes":[["XRLPZVCTDGM6JC7IZTA3CSSKJ2MHUHMKOR6JHMNUXMSXC7MD6AZAC","first"],["AA",null]],"deps":[],"known":[]},"hunks":[{"FileAdd":{"meta":{"basename":"README.md","metadata":0},"context":[{"change":1,"pos":0}],"contents":[{"Add":"## What is this?"},{"Add":""},{"Add":"This is intended to serve as a reference for developers interested in working on/contributing to Pijul."},{"Add":""},{"Add":"## Before submitting a patch"},{"Add":""},{"Add":"Please run `cargo fmt` to format your changes before submitting a patch. As long as you have cargo fmt installed, you can get pijul to do this for you by adding the following to `.pijul/config`:"},{"Add":"```"},{"Add":"[hooks]"},{"Add":"record = [ \"cargo fmt\" ]"},{"Add":"```"},{"Add":""},{"Add":"## For contributors using Rust Analyzer (esp. with VScode):"},{"Add":"By default, Rust Analyzer runs `cargo check` with the `--test` flag included, which can really slow down editor interactions and feedback. For VScode users, it's recommended to set up a workspace in your local copy of the pijul repository. An example of a basic workspace file can be found below; you would edit the `` entry to point to your cargo binary, and place this file in the project root as IE `pijul.code-workspace`. When you open vscode, it will ask you if you want to open the workspace."},{"Add":""},{"Add":"Example pijul.code-workspace:"},{"Add":"```"},{"Add":"{"},{"Add":"\t\"folders\": ["},{"Add":"\t\t{"},{"Add":"\t\t\t\"path\": \".\""},{"Add":"\t\t}"},{"Add":" ],"},{"Add":" \"settings\": {"},{"Add":" \"rust-analyzer.checkOnSave.overrideCommand\": ["},{"Add":" \"\""},{"Add":" \"check\","},{"Add":" \"--workspace\","},{"Add":" \"--message-format=json\","},{"Add":" \"--manifest-path\","},{"Add":" \"./Cargo.toml\","},{"Add":" \"--lib\","},{"Add":" \"--bins\","},{"Add":" \"--examples\""},{"Add":" ]"},{"Add":" }"},{"Add":"}"},{"Add":"```"},{"Add":""},{"Add":"For users of other editors, if RA is taking a long time and reporting a large number of errors, this would be the first place to look. If you have a specific workaround for your setup, please submit it as a patch and it will be added to this list."},{"Add":""},{"Add":""},{"Add":"## Scripting tricks (for tests, automation, etc.)"},{"Add":"When testing modifications or debugging issues, it's often the case that you'll want to recreate fairly complex situations and repository states quickly and in a reproducible manner. To that end, it's useful to know how to write scripts that interact with pijul."},{"Add":""},{"Add":"### Forcing specific timestamps"},{"Add":"`pijul record --timestamp `"},{"Add":""},{"Add":"### Minimizing interactive editor pop-ups/pager interactions during script execution"},{"Add":""},{"Add":"#### Record a patch without being prompted for hunk selection/change message"},{"Add":"`pijul record --all --message \"\"`"},{"Add":""},{"Add":"#### Push/pull without being prompted for hunk selection"},{"Add":"`pijul pull --all `"},{"Add":""},{"Add":"`pijul push --all `"},{"Add":""},{"Add":"## Logging"},{"Add":""},{"Add":"Pijul uses [log](https://crates.io/crates/log) and [env_logger](https://crates.io/crates/env_logger) to log messages to stdout; messages are tagged with priority levels (`log` provides the levels error, warn, info, debug, trace). The function that sets up pijul's logging is `pijul::env_logger_init`. You can consult the documentation for `log` and `env_logger` to get more information, but to turn logging on, run pijul with:"},{"Add":""},{"Add":"```"},{"Add":"RUST_LOG= "},{"Add":"```"},{"Add":""},{"Add":"for example:"},{"Add":""},{"Add":"```"},{"Add":"RUST_LOG=warn pijul change"},{"Add":"```"},{"Add":""},{"Add":"A quick and dirty example of how you can add new logging messages with the macros provided by log (which use standard format string syntax):"},{"Add":"```"},{"Add":"fn some_fun() {"},{"Add":" ..."},{"Add":" log::warn!(\"I want to see this value: {}\", value);"},{"Add":" "},{"Add":" ..."},{"Add":"}"},{"Add":"```"},{"Add":""},{"Add":"## Important types, API touchstones"},{"Add":""},{"Add":"### Transactions"},{"Add":""},{"Add":"The big ticket source of state is a transaction (often these variables are called `txn` in the source code). There are different `_TxnT` traits implemented by different types of transaction, but the basic concrete type for a transaction is `GenericTxn`"},{"Add":""},{"Add":"### pijul::repository::Repository"},{"Add":""},{"Add":"Unsurprisingly, this contains a lot of state pertaining to a particular repository."},{"Add":""},{"Add":"### pijul::remote::RemoteRepo"},{"Add":""},{"Add":"`RemoteRepo` is a concrete type frequently used to interact with a Transaction. `RemoteRepo` is an enum, with a variant for each kind of remote; Local, Ssh, Http, LocalChannel, as well as a bookkeeping `None` variant. For clarity, `Local` represents a local repo other than the one the user is currently working within, while `LocalChannel` is a channel within the current repo."},{"Add":""},{"Add":"### libpijul::pristine::Hash and libpijul::pristine::Merkle"},{"Add":""},{"Add":"`Hash` and `SerializedHash` are sequences of bytes which represent changes."},{"Add":""},{"Add":"`Merkle` and `SerializedMerkle` are sequences of bytes which represent the state of a repository."},{"Add":""},{"Add":"Both `Hash` and `Merkle` appear to users as strings of [base32](https://en.wikipedia.org/wiki/Base32). "},{"Add":""},{"Add":"You can freely convert between Hash <-> SerializedHash and Merkle <-> SerializedMerkle using the `From` and `Into` traits. Example: `Hash::from(_)` or `my_hash.into()`."},{"Add":""},{"Add":"## Common tasks in Pijul's codebase"},{"Add":""},{"Add":"### Visiting the change log"},{"Add":""},{"Add":"Use `TxnTExt::reverse_log(..)` (most recent first) or `TxnTExt::log(..)` (oldest first). You'll need a transaction and a `ChannelRef`. An example can be found in `pijul::command::log.rs`."}]}}],"owner":"pijul","repo":"pijul_contrib_guide","token":"v66yBkXX80NVeGOPmKSRpBO2cOajrU5A/oACtx8iqyg=","login":null}

…

Dependencies

Change contents