Jonathan Perkin <jperkin%joyent.com@localhost> writes: > * On 2020-09-15 at 10:46 BST, Nia Alarie wrote: > >> +# \todo pkgsrc cwrappers creates symlinks which make GCC pretend to be clang. > > Not picking on Nia, but noticing this being added a lot recently. Why > are we using this weird <tab>odo marker for things? Seems to be a > LaTeX reference, but these are Makefiles, not TeX documents. > > Can we not just use the regular ascii TODO: and XXX: instead, with the > added benefit that popular editors recognise these as valid markers > for Makefiles and will syntax accordingly? It's doxygen markup, which I find normal, probably because I've been using latex forever, and I'm probably the one that started doing it. It's used within source code in comments, so it doesn't non-fit to me. (And yes, I realize doxygen probably doesn't deal with BSD makefiles.) I prefer \todo to TODO: becuase it is clearly an exact-match keyword rather than something that's almost normal text. But it's not a big deal, and indeed we should have a single convention. TODO: is ok, if we settle on that - but then it has to be exactly that. (I don't like XXX, despite the the BSD heritage.)
Attachment:
signature.asc
Description: PGP signature