ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity
jj/v0.11.0/templates/index.html

1648 lines
39 KiB
HTML
Raw Normal View History

Deployed f00f752 to v0.11.0 with MkDocs 1.5.2 and mike 1.1.2
2023-11-01 18:13:55 +00:00
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://martinvonz.github.io/jj/v0.11.0/templates/">
<link rel="prev" href="../revsets/">
<link rel="next" href="../git-comparison/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">
<title>Templating language - Jujutsu docs</title>
<link rel="stylesheet" href="../assets/stylesheets/main.0e669242.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#templates" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Jujutsu docs" class="md-header__button md-logo" aria-label="Jujutsu docs" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Jujutsu docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Templating language
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Jujutsu docs" class="md-nav__button md-logo" aria-label="Jujutsu docs" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
Jujutsu docs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../install-and-setup/" class="md-nav__link">
<span class="md-ellipsis">
Installation and Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../tutorial/" class="md-nav__link">
<span class="md-ellipsis">
Tutorial and Birds-Eye View
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../github/" class="md-nav__link">
<span class="md-ellipsis">
Working with GitHub
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../FAQ/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../working-copy/" class="md-nav__link">
<span class="md-ellipsis">
Working Copy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../branches/" class="md-nav__link">
<span class="md-ellipsis">
Branches
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../conflicts/" class="md-nav__link">
<span class="md-ellipsis">
Conflicts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../operation-log/" class="md-nav__link">
<span class="md-ellipsis">
Operation Log
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../glossary/" class="md-nav__link">
<span class="md-ellipsis">
Glossary
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Configuration
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Configuration
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../config/" class="md-nav__link">
<span class="md-ellipsis">
Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../revsets/" class="md-nav__link">
<span class="md-ellipsis">
Revset language
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Templating language
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Templating language
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#keywords" class="md-nav__link">
Keywords
</a>
<nav class="md-nav" aria-label="Keywords">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#commit-keywords" class="md-nav__link">
Commit keywords
</a>
</li>
<li class="md-nav__item">
<a href="#operation-keywords" class="md-nav__link">
Operation keywords
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#operators" class="md-nav__link">
Operators
</a>
</li>
<li class="md-nav__item">
<a href="#global-functions" class="md-nav__link">
Global functions
</a>
</li>
<li class="md-nav__item">
<a href="#types" class="md-nav__link">
Types
</a>
<nav class="md-nav" aria-label="Types">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#boolean-type" class="md-nav__link">
Boolean type
</a>
</li>
<li class="md-nav__item">
<a href="#commit-type" class="md-nav__link">
Commit type
</a>
</li>
<li class="md-nav__item">
<a href="#commitid-changeid-type" class="md-nav__link">
CommitId / ChangeId type
</a>
</li>
<li class="md-nav__item">
<a href="#integer-type" class="md-nav__link">
Integer type
</a>
</li>
<li class="md-nav__item">
<a href="#list-type" class="md-nav__link">
List type
</a>
</li>
<li class="md-nav__item">
<a href="#listtemplate-type" class="md-nav__link">
ListTemplate type
</a>
</li>
<li class="md-nav__item">
<a href="#operationid-type" class="md-nav__link">
OperationId type
</a>
</li>
<li class="md-nav__item">
<a href="#refname-type" class="md-nav__link">
RefName type
</a>
</li>
<li class="md-nav__item">
<a href="#shortestidprefix-type" class="md-nav__link">
ShortestIdPrefix type
</a>
</li>
<li class="md-nav__item">
<a href="#signature-type" class="md-nav__link">
Signature type
</a>
</li>
<li class="md-nav__item">
<a href="#string-type" class="md-nav__link">
String type
</a>
<nav class="md-nav" aria-label="String type">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#string-literals" class="md-nav__link">
String literals
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#template-type" class="md-nav__link">
Template type
</a>
</li>
<li class="md-nav__item">
<a href="#timestamp-type" class="md-nav__link">
Timestamp type
</a>
</li>
<li class="md-nav__item">
<a href="#timestamprange-type" class="md-nav__link">
TimestampRange type
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
Configuration
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Comparisons
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Comparisons
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../git-comparison/" class="md-nav__link">
<span class="md-ellipsis">
Git comparison
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../git-compatibility/" class="md-nav__link">
<span class="md-ellipsis">
Git compatibility
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../sapling-comparison/" class="md-nav__link">
<span class="md-ellipsis">
Sapling
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../related-work/" class="md-nav__link">
<span class="md-ellipsis">
Other related work
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Technical details
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Technical details
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../technical/architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../technical/concurrency/" class="md-nav__link">
<span class="md-ellipsis">
Concurrency
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../technical/conflicts/" class="md-nav__link">
<span class="md-ellipsis">
Conflicts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Contributing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../contributing/" class="md-nav__link">
<span class="md-ellipsis">
Guidelines and "How to...?"
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../code-of-conduct/" class="md-nav__link">
<span class="md-ellipsis">
Code of conduct
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
<span class="md-ellipsis">
Design docs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9">
<span class="md-nav__icon md-icon"></span>
Design docs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/git-submodules/" class="md-nav__link">
<span class="md-ellipsis">
git-submodules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../design/git-submodule-storage/" class="md-nav__link">
<span class="md-ellipsis">
git-submodule-storage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../design/run/" class="md-nav__link">
<span class="md-ellipsis">
JJ run
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../design/tracking-branches/" class="md-nav__link">
<span class="md-ellipsis">
Tracking branches
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#keywords" class="md-nav__link">
Keywords
</a>
<nav class="md-nav" aria-label="Keywords">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#commit-keywords" class="md-nav__link">
Commit keywords
</a>
</li>
<li class="md-nav__item">
<a href="#operation-keywords" class="md-nav__link">
Operation keywords
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#operators" class="md-nav__link">
Operators
</a>
</li>
<li class="md-nav__item">
<a href="#global-functions" class="md-nav__link">
Global functions
</a>
</li>
<li class="md-nav__item">
<a href="#types" class="md-nav__link">
Types
</a>
<nav class="md-nav" aria-label="Types">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#boolean-type" class="md-nav__link">
Boolean type
</a>
</li>
<li class="md-nav__item">
<a href="#commit-type" class="md-nav__link">
Commit type
</a>
</li>
<li class="md-nav__item">
<a href="#commitid-changeid-type" class="md-nav__link">
CommitId / ChangeId type
</a>
</li>
<li class="md-nav__item">
<a href="#integer-type" class="md-nav__link">
Integer type
</a>
</li>
<li class="md-nav__item">
<a href="#list-type" class="md-nav__link">
List type
</a>
</li>
<li class="md-nav__item">
<a href="#listtemplate-type" class="md-nav__link">
ListTemplate type
</a>
</li>
<li class="md-nav__item">
<a href="#operationid-type" class="md-nav__link">
OperationId type
</a>
</li>
<li class="md-nav__item">
<a href="#refname-type" class="md-nav__link">
RefName type
</a>
</li>
<li class="md-nav__item">
<a href="#shortestidprefix-type" class="md-nav__link">
ShortestIdPrefix type
</a>
</li>
<li class="md-nav__item">
<a href="#signature-type" class="md-nav__link">
Signature type
</a>
</li>
<li class="md-nav__item">
<a href="#string-type" class="md-nav__link">
String type
</a>
<nav class="md-nav" aria-label="String type">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#string-literals" class="md-nav__link">
String literals
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#template-type" class="md-nav__link">
Template type
</a>
</li>
<li class="md-nav__item">
<a href="#timestamp-type" class="md-nav__link">
Timestamp type
</a>
</li>
<li class="md-nav__item">
<a href="#timestamprange-type" class="md-nav__link">
TimestampRange type
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
Configuration
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="templates">Templates<a class="headerlink" href="#templates" title="Permanent link">&para;</a></h1>
<p>Jujutsu supports a functional language to customize output of commands.
The language consists of literals, keywords, operators, functions, and
methods.</p>
<p>A couple of <code>jj</code> commands accept a template via <code>-T</code>/<code>--template</code> option.</p>
<h2 id="keywords">Keywords<a class="headerlink" href="#keywords" title="Permanent link">&para;</a></h2>
<p>Keywords represent objects of different types; the types are described in
a follow-up section.</p>
<h3 id="commit-keywords">Commit keywords<a class="headerlink" href="#commit-keywords" title="Permanent link">&para;</a></h3>
<p>The following keywords can be used in <code>jj log</code>/<code>jj obslog</code> templates.</p>
<ul>
<li><code>description: String</code></li>
<li><code>change_id: ChangeId</code></li>
<li><code>commit_id: CommitId</code></li>
<li><code>parents: List&lt;Commit&gt;</code></li>
<li><code>author: Signature</code></li>
<li><code>committer: Signature</code></li>
<li><code>working_copies: String</code>: For multi-workspace repository, indicate
working-copy commit as <code>&lt;workspace name&gt;@</code>.</li>
<li><code>current_working_copy: Boolean</code>: True for the working-copy commit of the
current workspace.</li>
<li><code>branches: List&lt;RefName&gt;</code>: Local and remote branches pointing to the commit.
A tracking remote branch will be included only if its target is different
from the local one.</li>
<li><code>local_branches: List&lt;RefName&gt;</code>: All local branches pointing to the commit.</li>
<li><code>remote_branches: List&lt;RefName&gt;</code>: All remote branches pointing to the commit.</li>
<li><code>tags: List&lt;RefName&gt;</code></li>
<li><code>git_refs: List&lt;RefName&gt;</code></li>
<li><code>git_head: List&lt;RefName&gt;</code></li>
<li><code>divergent: Boolean</code>: True if the commit's change id corresponds to multiple
visible commits.</li>
<li><code>hidden: Boolean</code>: True if the commit is not visible (a.k.a. abandoned).</li>
<li><code>conflict: Boolean</code>: True if the commit contains merge conflicts.</li>
<li><code>empty: Boolean</code>: True if the commit modifies no files.</li>
<li><code>root: Boolean</code>: True if the commit is the root commit.</li>
</ul>
<h3 id="operation-keywords">Operation keywords<a class="headerlink" href="#operation-keywords" title="Permanent link">&para;</a></h3>
<p>The following keywords can be used in <code>jj op log</code> templates.</p>
<ul>
<li><code>current_operation: Boolean</code></li>
<li><code>description: String</code></li>
<li><code>id: OperationId</code></li>
<li><code>tags: String</code></li>
<li><code>time: TimestampRange</code></li>
<li><code>user: String</code></li>
</ul>
<h2 id="operators">Operators<a class="headerlink" href="#operators" title="Permanent link">&para;</a></h2>
<p>The following operators are supported.</p>
<ul>
<li><code>x.f()</code>: Method call.</li>
<li><code>x ++ y</code>: Concatenate <code>x</code> and <code>y</code> templates.</li>
</ul>
<h2 id="global-functions">Global functions<a class="headerlink" href="#global-functions" title="Permanent link">&para;</a></h2>
<p>The following functions are defined.</p>
<ul>
<li><code>fill(width: Integer, content: Template) -&gt; Template</code>: Fill lines at
the given <code>width</code>.</li>
<li><code>indent(prefix: Template, content: Template) -&gt; Template</code>: Indent
non-empty lines by the given <code>prefix</code>.</li>
<li><code>label(label: Template, content: Template) -&gt; Template</code>: Apply label to
the content. The <code>label</code> is evaluated as a space-separated string.</li>
<li><code>if(condition: Boolean, then: Template[, else: Template]) -&gt; Template</code>:
Conditionally evaluate <code>then</code>/<code>else</code> template content.</li>
<li><code>concat(content: Template...) -&gt; Template</code>:
Same as <code>content_1 ++ ... ++ content_n</code>.</li>
<li><code>separate(separator: Template, content: Template...) -&gt; Template</code>:
Insert separator between <strong>non-empty</strong> contents.</li>
</ul>
<h2 id="types">Types<a class="headerlink" href="#types" title="Permanent link">&para;</a></h2>
<h3 id="boolean-type">Boolean type<a class="headerlink" href="#boolean-type" title="Permanent link">&para;</a></h3>
<p>No methods are defined. Can be constructed with <code>false</code> or <code>true</code> literal.</p>
<h3 id="commit-type">Commit type<a class="headerlink" href="#commit-type" title="Permanent link">&para;</a></h3>
<p>This type cannot be printed. All commit keywords are accessible as 0-argument
methods.</p>
<h3 id="commitid-changeid-type">CommitId / ChangeId type<a class="headerlink" href="#commitid-changeid-type" title="Permanent link">&para;</a></h3>
<p>The following methods are defined.</p>
<ul>
<li><code>.short([len: Integer]) -&gt; String</code></li>
<li><code>.shortest([min_len: Integer]) -&gt; ShortestIdPrefix</code>: Shortest unique prefix.</li>
</ul>
<h3 id="integer-type">Integer type<a class="headerlink" href="#integer-type" title="Permanent link">&para;</a></h3>
<p>No methods are defined.</p>
<h3 id="list-type">List type<a class="headerlink" href="#list-type" title="Permanent link">&para;</a></h3>
<p>A list can be implicitly converted to <code>Boolean</code>. The following methods are
defined.</p>
<ul>
<li><code>.join(separator: Template) -&gt; Template</code>: Concatenate elements with
the given <code>separator</code>.</li>
<li><code>.map(|item| expression) -&gt; ListTemplate</code>: Apply template <code>expression</code>
to each element. Example: <code>parents.map(|c| c.commit_id().short())</code></li>
</ul>
<h3 id="listtemplate-type">ListTemplate type<a class="headerlink" href="#listtemplate-type" title="Permanent link">&para;</a></h3>
<p>The following methods are defined. See also the <code>List</code> type.</p>
<ul>
<li><code>.join(separator: Template) -&gt; Template</code></li>
</ul>
<h3 id="operationid-type">OperationId type<a class="headerlink" href="#operationid-type" title="Permanent link">&para;</a></h3>
<p>The following methods are defined.</p>
<ul>
<li><code>.short([len: Integer]) -&gt; String</code></li>
</ul>
<h3 id="refname-type">RefName type<a class="headerlink" href="#refname-type" title="Permanent link">&para;</a></h3>
<p>The following methods are defined.</p>
<ul>
<li><code>.name() -&gt; String</code>: Local branch or tag name.</li>
<li><code>.remote() -&gt; String</code>: Remote name or empty if this is a local ref.</li>
</ul>
<h3 id="shortestidprefix-type">ShortestIdPrefix type<a class="headerlink" href="#shortestidprefix-type" title="Permanent link">&para;</a></h3>
<p>The following methods are defined.</p>
<ul>
<li><code>.prefix() -&gt; String</code></li>
<li><code>.rest() -&gt; String</code></li>
<li><code>.upper() -&gt; ShortestIdPrefix</code></li>
<li><code>.lower() -&gt; ShortestIdPrefix</code></li>
</ul>
<h3 id="signature-type">Signature type<a class="headerlink" href="#signature-type" title="Permanent link">&para;</a></h3>
<p>The following methods are defined.</p>
<ul>
<li><code>.name() -&gt; String</code></li>
<li><code>.email() -&gt; String</code></li>
<li><code>.username() -&gt; String</code></li>
<li><code>.timestamp() -&gt; Timestamp</code></li>
</ul>
<h3 id="string-type">String type<a class="headerlink" href="#string-type" title="Permanent link">&para;</a></h3>
<p>A string can be implicitly converted to <code>Boolean</code>. The following methods are
defined.</p>
<ul>
<li><code>.contains(needle: Template) -&gt; Boolean</code></li>
<li><code>.first_line() -&gt; String</code></li>
<li><code>.lines() -&gt; List&lt;String&gt;</code>: Split into lines excluding newline characters.</li>
<li><code>.upper() -&gt; String</code></li>
<li><code>.lower() -&gt; String</code></li>
<li><code>.starts_with(needle: Template) -&gt; Boolean</code></li>
<li><code>.ends_with(needle: Template) -&gt; Boolean</code></li>
<li><code>.remove_prefix(needle: Template) -&gt; String</code>: Removes the passed prefix, if present</li>
<li><code>.remove_suffix(needle: Template) -&gt; String</code>: Removes the passed suffix, if present</li>
<li><code>.substr(start: Integer, end: Integer) -&gt; String</code>: Extract substring. Negative values count from the end.</li>
</ul>
<h4 id="string-literals">String literals<a class="headerlink" href="#string-literals" title="Permanent link">&para;</a></h4>
<p>String literals must be surrounded by double quotes (<code>"</code>). The following escape
sequences starting with a backslash have their usual meaning: <code>\"</code>, <code>\\</code>, <code>\n</code>,
<code>\r</code>, <code>\t</code>, <code>\0</code>. Other escape sequences are not supported. Any UTF-8 characters
are allowed inside a string literal, with two exceptions: unescaped <code>"</code>-s and
uses of <code>\</code> that don't form a valid escape sequence.</p>
<h3 id="template-type">Template type<a class="headerlink" href="#template-type" title="Permanent link">&para;</a></h3>
<p>Most types can be implicitly converted to <code>Template</code>. No methods are defined.</p>
<h3 id="timestamp-type">Timestamp type<a class="headerlink" href="#timestamp-type" title="Permanent link">&para;</a></h3>
<p>The following methods are defined.</p>
<ul>
<li><code>.ago() -&gt; String</code>: Format as relative timestamp.</li>
<li><code>.format(format: String) -&gt; String</code>: Format with <a href="https://docs.rs/chrono/latest/chrono/format/strftime/">the specified strftime-like
format string</a>.</li>
<li><code>.utc() -&gt; Timestamp</code>: Convert timestamp into UTC timezone.</li>
</ul>
<h3 id="timestamprange-type">TimestampRange type<a class="headerlink" href="#timestamprange-type" title="Permanent link">&para;</a></h3>
<p>The following methods are defined.</p>
<ul>
<li><code>.start() -&gt; Timestamp</code></li>
<li><code>.end() -&gt; Timestamp</code></li>
<li><code>.duration() -&gt; String</code></li>
</ul>
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
<p>The default templates and aliases() are defined in the <code>[templates]</code> and
<code>[template-aliases]</code> sections of the config respectively. The exact definitions
can be seen in the <code>cli/src/config/templates.toml</code> file in jj's source tree.</p>
<!--- TODO: Find a way to embed the default config files in the docs -->
<p>New keywords and functions can be defined as aliases, by using any
combination of the predefined keywords/functions and other aliases.</p>
<p>For example:</p>
<div class="highlight"><pre><span></span><code><span class="k">[template-aliases]</span>
<span class="s">&#39;commit_change_ids&#39;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&#39;&#39;&#39;</span>
<span class="s">concat(</span>
<span class="s"> format_field(&quot;Commit ID&quot;, commit_id),</span>
<span class="s"> format_field(&quot;Change ID&quot;, commit_id),</span>
<span class="s">)</span>
<span class="s">&#39;&#39;&#39;</span>
<span class="s">&#39;format_field(key, value)&#39;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&#39;key ++ &quot;: &quot; ++ value ++ &quot;\n&quot;&#39;</span>
</code></pre></div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.78eede0e.min.js"></script>
</body>
</html>
Copy permalink