LINTIAN-BRUSH(5)

πŸ’– LINTIAN-BRUSH(5) πŸ’–

okay bestie, so this is the lintian-brush(5) page from the File Formats Manual section, and it's literally all about the per-package config file. it's giving very demure, very mindful, very configuration. let's get into it πŸŽ€


✨ NAME ✨

debian/lintian-brush.conf β€” the per-package configuration file for lintian-brush, i.e. the little file where you tell lintian-brush how to behave for your package specifically 🫢


🌸 DESCRIPTION 🌸

so basically, a lintian-brush per-package configuration file is made up of a series of single key/value pairs. that's it. that's the whole vibe. no nesting, no drama, just key = value, one after another.

this config file should live inside the package at:

debian/lintian-brush.conf

and the hash sign # is the comment character. literally any text after a # all the way to the end of that line gets straight-up ignored. so go ahead and leave yourself little notes, nobody's reading them except you πŸ’…


πŸ‘‘ VARIABLES πŸ‘‘

these are the variables that are currently supported, bestie β€” not "these are some of the variables", this is the whole list, so don't come for me:

πŸ¦‹ compat-release = RELEASE

compat-release says which oldest release the package is trying to stay compatible with. the way that lintian-brush works is that it will not make any changes that would require packages or features that aren't present in that release. so like, it's a hard boundary, not a suggestion ✨

the supported values are Debian and Ubuntu code names, plus the aliases:

  • testing
  • experimental
  • stable
  • unstable
⚠️ heads up: version numbers are currently not supported. so don't try to be cute and put a 12 in there, it won't work, and i would simply pass away 😭

the default compat-release is "stable".

🌈 allow-reformatting = True|False

if allow-reformatting is enabled, lintian-brush will make changes to debian files in a way that does not necessarily preserve existing formatting. yes, it will absolutely go in and rearrange your little formatting situation. slay but also rude, i know.

if it's disabled, lintian-brush will not run any fixers that cannot preserve formatting. so everything stays exactly as you typed it, no cap πŸŽ€

πŸ’œ update-changelog = True|False

the update-changelog setting is the one that decides whether new lines get added to the changelog for all the changes lintian-brush has made to the package. like, do you want receipts in the changelog or not?

by default, lintian-brush will automatically figure out whether the changelog should be updated β€” and it does this using some basic heuristics, such as checking for the presence of a [dch] section in debian/gbp.conf. so it's out here doing detective work on your behalf πŸ”

you may want to set this to False if you are using gbp dch to generate your changelog entries. in that case, let gbp dch have its moment and do its thing, periodt πŸ™ˆ


πŸ”₯ SEE ALSO πŸ”₯

go read those too, iykyk πŸ“š


⭐ AUTHORS ⭐

Jelmer Vernooij <jelmer@debian.org> β€” iconic behavior honestly πŸ‘‘


and that's the whole page, bestie!! this was lintian-brush version 0.1, dated October 2018 πŸŽ€ thanks for reading, love u, go configure your package πŸ’–πŸ¦‹βœ¨