Documentation

Commentary

This package provides a backend for vc.el to handle Jujutsu (jj)
repositories.  Jujutsu uses a change-centric model that differs in
important ways from Git’s commit-centric model.  Vc-jj adapts
vc.el’s abstractions to match jj terminology and behavior.

Users may see and customize all options by pressing

 'M-x customize-group vc-jj RET'

and using the Customize menu.

Additional information about Jujutsu and vc-jj.el may be found in
the README.org file.  The NEWS.org file contains user-relevant
information regarding bug fixes, additions, and changes organized
by version.

The vc-jj.el project repository can be found online at
https://codeberg.org/emacs-jj-vc/vc-jj.el.

STATUS AND LIMITATIONS

Vc-jj implements most commonly used vc.el commands (such as
`vc-dir', `vc-diff', `vc-print-log', and file state queries), but
some operations are not yet supported or behave differently from
vc-git due to jj’s model.

FILE STRUCTURE

After the "Customization" and "Internal Utilities" sections, the
organization of vc-jj.el file matches the "BACKEND PROPERTIES"
section of the preamble of the vc.el file: each outline heading
corresponds to a vc backend method and the contents of each heading
relate to implementing that backend method.

FEEDBACK AND CONTRIBUTIONS

Bug reports and contributions are welcome, especially for
unimplemented vc.el backend methods.  The home of this project is
found here: https://codeberg.org/emacs-jj-vc/vc-jj.el.  Users may
file bug reports in the "Issues" tab and create pull requests in
the "Pull requests" tab.

Vc-jj prefers Jujutsu's terminology and attempts to adhere to it,
so we ask contributors to try their best to use the terminology
specific to jujutsu as opposed to other version control systems,
such as Git.  A brief description of these differences can be found
in the README.

Additionally, contributors should adhere to the following
capitalization and terminology conventions:
- "Jujutsu" refers to the Jujutsu version control system.
- "jj" refers to the Jujutsu command-line tool or its commands.
- "Jj" is used when "jj" would otherwise begin a sentence.
- "vc-jj" may be used to refer to this Emacs package.
- "Vc-jj" is used when "vc-jj" would otherwise begin a sentence.

Consumers

Reverse Dependencies

No reverse dependencies recorded.