branch: externals/vc-jj
commit 8c5937fb85e6d78b4dc5ea5e9d97f65b8ed518f0
Author: Rudi Schlatte <[email protected]>
Commit: Rudi Schlatte <[email protected]>
Further markup tweaks
Use tilde for anything code-related (shell commands, function names,
etc.) and equal sign for filenames, project names and similar.
---
README.org | 31 ++++++++++++++++---------------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/README.org b/README.org
index bc9feb1b35..4d6da683ea 100644
--- a/README.org
+++ b/README.org
@@ -2,7 +2,7 @@
* jj (Jujutsu) integration with Emacs vc.el and project.el
-Support for Emacs built-in
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Version-Control.html][~vc.el~]]
and
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Projects.html][~project.el~]]
for the [[https://github.com/jj-vcs/jj][Jujutsu]]
+Support for Emacs built-in
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Version-Control.html][=vc.el=]]
and
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Projects.html][=project.el=]]
for the [[https://github.com/jj-vcs/jj][Jujutsu]]
version control system.
[[file:screenshots/screenshot-1.png]]
@@ -37,8 +37,8 @@ help users manipulate revision logs in a jujutsu-friendly way,
directly within Log View buffers: ~vc-jj-log-view-bookmark-set~,
~vc-jj-log-view-abandon-change~, ~vc-jj-log-view-edit-change~ and more.
-To see all available commands call =C-h a vc-jj RET=. To see all
-available customization options, call =M-x customize-group vc-jj RET=.
+To see all available commands call ~C-h a vc-jj RET~. To see all
+available customization options, call ~M-x customize-group vc-jj RET~.
** Jujutsu configuration
@@ -64,14 +64,14 @@ storage backend jujutsu supports is Git, although other
storage
backends may be supported in the future.
Since version 0.34.0, jujutsu repositories are "colocated" by default.
-Earlier versions of jujutsu may colocate a Git repository with ~jj git clone
--colocate REPOSITORY-URL~.
-Colocated repositories are ones that contain both a ~.jj~ and a ~.git~
-directory in the repository root, allowing users to use both Jujutsu
-and Git commands in the same repository, without one getting in the
-way of the other. (Although Git will complain about being in
-"detached HEAD" state.) Because of this colocation, vc-jj can reuse
-some vc-git functionality where appropriate, such as handling
-~.gitignore~ files.
+Earlier versions of jujutsu may colocate a Git repository with
+~jj git clone --colocate REPOSITORY-URL~. Colocated repositories are
+ones that contain both a =.jj= and a =.git= directory in the
+repository root, allowing users to use both Jujutsu and Git commands
+in the same repository, without one getting in the way of the other.
+(Although Git will complain about being in "detached HEAD" state.)
+Because of this colocation, vc-jj can reuse some vc-git functionality
+where appropriate, such as handling =.gitignore= files.
** Jujutsu terminology and concepts
@@ -147,14 +147,15 @@ place; feel free to contact us for details. Note that
"trivial"
The code in file =vc-jj.el= is organized according to the structure set
out in the preamble of the file =vc.el= in the Emacs source tree.
-Test code coverage can be checked via the
[[https://emacs-eldev.github.io/eldev/][Eldev]] tool and
[[https://github.com/trezona-lecomte/coverage][coverage]]: run
-~eldev test --undercover simplecov,dontsend~ in the project root
-directory then activate =coverage-mode= inside =vc-jj.el=.
+Test code coverage can be checked via the
[[https://emacs-eldev.github.io/eldev/][Eldev]] tool and
[[https://github.com/trezona-lecomte/coverage][coverage]]: in
+a shell, run ~eldev test --undercover simplecov,dontsend~ in the
+project root directory, then in Emacs open =vc-jj.el= and activate
+~coverage-mode~.
* Other Emacs packages for Jujutsu
The scope of the =vc-jj.el= project is to add jj support to the Emacs
-built-in ~vc~ and ~project~ libraries. In case you look for a package
+built-in =vc= and =project= libraries. In case you look for a package
with more specialized jujutsu support, here are some that might fit
the bill:
