From f3049d634de568f8a87e96c8717dd43ecbff6079 Mon Sep 17 00:00:00 2001 From: Ariadne Conill Date: Mon, 25 Oct 2021 21:52:52 -0600 Subject: [PATCH] README: note that --debug output should not be considered stable --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5a41cae..5c65b84 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,14 @@ it to do. We will reject bugs like this, and if you choose to violate our [Code of Conduct](CODE_OF_CONDUCT.md) by demanding we fix your non-bug, we will fix the problem by banning you from the repo instead. +## debug output + +Please use only the stable interfaces to query pkg-config. Do not screen-scrape the +output from `--debug`: this is sent to `stderr` for a reason, it is not intended to be +scraped. The `--debug` output is **not** a stable interface, and should **never** be +depended on as a source of information. If you need a stable interface to query pkg-config +which is not covered, please get in touch. + ## compiling `pkgconf` and `libpkgconf` on UNIX pkgconf is basically compiled the same way any other autotools-based project is