BK-ANNOTATE(1)

🌸 bk annotate(none) — the BitKeeper User's Manual, bestie edition 🌸

okay so real quick, this is a page from the BitKeeper User's Manual — buckle up, it's a good one 💅

---

✨ NAME ✨

bk annotate — gives you annotated listings of one or more source files. cute, useful, iconic 🎀

---

🦋 SYNOPSIS 🦋

bk annotate [options] [file ... | −]

---

💖 DESCRIPTION 💖

so BitKeeper annotations literally add an extra level of information — think date, author, etc. — while you're viewing file contents. Annotated listings are highkey useful for a deeper understanding of your source base, like when you're out here tracking down bugs 🔥

BitKeeper has two kinds of annotations, bestie:

• annotations of a specific version of a file
• annotations of all (or some) versions of a file — that second form is unique to BitKeeper, no cap 👑

By default, the bk annotate command displays a specific version of a file with annotations. The default version of a file is the most recent version; the −r option lets you specify an alternative version. The default annotations are the revision in which the change was made and the user who made that change. And psst — selecting any annotations overrides all of the default annotations 🫶

There's also an alternate form of the bk annotate command that shows or annotates either all lines added by all versions, or just the lines added by one or more versions. In that latter case, the whole file is not displayed — instead, only the lines which were added in that range of changes are displayed. The −R option turns on this form of annotation. Each version of a line is grouped closely with other versions of that line, which is so helpful for determining when a particular feature was added or modified 🌈

This form of annotation has no annotations by default — the desired annotations must be specified. If no annotations are specified, then the selected lines are shown without annotations. periodt.

---

💅 OPTIONS 💅

• −A5dnpru — Align annotations in a human readable form. The set of annotations will be followed by a vertical bar and a space before the data from each line of the file starts. Each annotation is aligned in a column. The option argument[s] turn on one or more annotations as a prefix to each line. The order of annotations is fixed (no matter what order you specify them) and it's the same as the order listed below ⭐
  • p — Prefix each line with the pathname of the file relative to the current working directory. The name is always the current name of the file even if it has been renamed. iykyk, renames don't lie here 🧚
  • d — Prefix each line with the date of last modification.
  • u — Prefix each line with the name of the user who last modified it.
  • r — Prefix each line with the revision of the last modification.
  • 5 — Prefix each line with the MD5 key of the last modification.
  • n — Prefix each line with its line number.
• −a5dnpru — Similar to −A but without the alignment (each annotation is followed by a tab). The order of fields is fixed and is: pathname, date, user, revision, md5key, line number. simple, clean, no notes 💜
• −cdates — annotate only the lines added by the specified range of dates. See bk range for information on specifying dates.
• −k — do not expand RCS or SCCS keywords. This option is implied by −c and −R.
• −rrev — annotate all lines in this version of the file.
• −R[rev] — annotate only the lines added by the specified revision (or range of revisions). If rev is not specified, that implies all revisions (i.e., ..). The difference between this option and the previous option is that in this case bk annotate shows only those lines added by the specified revision[s], but in the −r case, the entire contents of the specified version is annotated. two totally different vibes fr fr 💀
• −w[rev] — Change the format of the r annotation from rev to rev−d<rev> in the case where the line is deleted from the rev passed as the argument, or rev‐x<rev> in the case where the line has been excluded. If no rev argument is given, the tip revision is used.

---

🍓 EXAMPLES 🍓

Annotate the latest revision of a file:

$ bk annotate foo.c

Annotate the lines added in the latest revision of that file:

$ bk annotate ‐R+ foo.c

Annotate all lines in all versions of that file:

$ bk annotate ‐R foo.c

Annotate all lines added to all files in the current directory between June 1 of 2010 and July 31 of 2010:

$ bk annotate ‐c2010/06..2010/07

To annotate all lines added between two tagged releases:

bk ‐U annotate ‐Rbk‐4.6..bk‐5.0

---

🙈 NOTES 🙈

okay so history lesson — in previous versions of BitKeeper, the −c option was used to select a single revision and annotate all lines in that revision. You can now get the same effect as the old:

bk annotate ‐c2000 foo.c

with the more complicated (this assumes bash is your shell):

bk annotate ‐r$(bk prs ‐1 ‐hnd:REV: ‐c..2000 foo.c) foo.c

not me crying at how much simpler the old way was 😭

---

🔍 SEE ALSO 🔍

bk‐get, bk‐grep, bk‐range, bk‐revtool

---

👑 CATEGORY 👑

File

---

💀 friendly little reminder: everything above is straight from the manpage — the flags, the paths, the examples, all of it. don't go inventing new ones, bestie.

---

that's the whole page! brought to you by BitKeeper Inc — version 1E1 — and it's the bk annotate(none) page, so go forth and annotate, you absolute main character 🌟💖