[COFF] Code/comment Ratios Style
Larry McVoy
lm at mcvoy.com
Tue Jul 22 10:08:16 AEST 2025
On Mon, Jul 21, 2025 at 06:26:56PM -0400, josh wrote:
> On Monday, July 21, 2025, Chet Ramey via COFF <coff at tuhs.org> wrote:
>
> > On 7/21/25 11:27 AM, Paul Winalski wrote:
> >
> >> When writing all but the most trivial bug fixes I always put in a comment
> >> referring to the bug report number. This helps with what can otherwise be
> >> a perplexing problem: "why is this bit of code there?"
> >>
> >
> > I put those in the change log entries.
> >
>
> Does anyone else feel like this is still an unsolved problem?
>
> It seems git blame continues to be the state of the art for connecting a
> section of code to the ???commit??? (or analogous concept) in which it was
> added, which is where one would include context about why the change was
> made and connect it to the wider world (bug tracker, etc).
This is the place where I find git most lacking. BitKeeper did this quite
differently, we have a graph per file plus the repository graph, git just
has the latter.
When debugging in BitKeeper, we had a GUI called revtool that gave you
the graph in the top and diffs or file in the bottom. So you find the
version that you want to look around, hit d for diffs, wander around,
as you hover over each line you see the checkin comments (instantly),
and eventually you find the suspect line. double click on it and it
warps you out to the commit in csettool.
So you go inside out. Git goes outside in. Drives me crazy so I still
use BitKeeper.
But I digress, the combination of git blame and git log is going to get
you there, I agree it is painful.
More information about the COFF
mailing list