BK-COMMENTS(1)

💬 bk comments — the glow-up your checkin comments deserve 💅

okay so first things first: this is a page straight out of the BitKeeper User's Manual, bestie. bk comments is the command, and honestly? It's giving "makeover montage but for commit messages." ✨

---

🌸 SYNOPSIS 🌸

bk comments [−p] [−Ccset] [−rrev] [file ... | −]
bk comments [−Ccset] [−rrev] [−ycmt] [−Yfile] [file ... | −]

Two whole moods, one command. Pick your fighter. 🫶

---

🦋 DESCRIPTION 🦋

So bk comments literally changes the stored comments for a revision controlled file. That's the whole vibe. 🎀

You can hand over the comments right there on the command line — no drama — but if you don't, the command is gonna plop you into your editor so you can type them in yourself. Cozy, honestly.

And here's the cute part: if you pass - as a file argument, bk comments reads a list of files and the comments to be edited from stdin. The format is literally this:

### Comments for file.c|1.23
this is a sample comment
### Comments for file2.h|1.2.3.4
these are
other comments

Chef's kiss. 🧚 The header line tells it which file and revision, the lines after are the actual comment. Easy.

---

✨ OPTIONS ✨

• −rrev — changes the comments for the revision you specify. If you don't say anything, it defaults to the most recent revision. main character default energy.
• −ycomment — uses comment as the new comment for every single file. all of them. no cap.
• −Yfile — uses the contents of file as the new comment for all files. same deal, but the comment text lives in a file instead.
• −Crev — edits all the file comments on the requested changeset at once. lowkey powerful. 👑 Cannot be combined with −r. that's a hard no.
• −p — generates the list of all comments in the files you requested and writes them to stdout. Why would you want that? Because you can edit that output and then feed it right back into bk comments - on stdin to actually change the comments. iconic workflow, honestly. 🔥

Also, heads up: if you give no files to edit on the command line, then −C+ is assumed and the comments for the files in the last changeset get edited. So it just… does the thing. 💀

---

💀 BUGS 💀

Nota bene, bestie — read this one twice:

If the deltas being commented have been committed to a changeset and have been pulled out of this repository, the comment changes will not propagate on the next bk pull. Like, they just won't. 😭

So it is strongly suggested that you use this only on uncommitted deltas which have not been pulled or cloned. That's the safe lane. Stay in it. 🙈

In the future, they say, they'll add a way of enforcing this. Until then — behave. 💜

---

🌈 SEE ALSO 🌈

• bk‐log
• bk‐sccslog

---

🍓 CATEGORY 🍓

File

---

and that's the whole page, bestie — go forth and fix those comments 💖

This one's brought to you by BitKeeper Inc, version 1E1, dated bk comments(none) in the footer — mwah, ty for reading, ily, bye 🎀