ariadne
/
pkgconf
3
6
Fork 4
Code Issues 6 Pull Requests 2 Projects Releases 2 Wiki Activity

[README.md] Soften and clarify wording #235

Merged
Olf0 merged 2 commits from patch-1 into master 2021-10-07 04:06:29 +00:00
Conversation 1 Commits 2 Files Changed 1
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -3,9 +3,9 @@
`pkgconf` is a program which helps to configure compiler and linker flags for `pkgconf` is a program which helps to configure compiler and linker flags for
development libraries. It is similar to pkg-config from freedesktop.org. development libraries. It is similar to pkg-config from freedesktop.org.
`libpkgconf` is a library which provides access to most of `pkgconf`'s functionality, to allow `libpkgconf` is a library which provides access to most of `pkgconf`'s functionality,
other tooling such as compilers and IDEs to discover and use libraries configured by to allow other tooling such as compilers and IDEs to discover and use libraries
pkgconf. configured by pkgconf.
## using `pkgconf` with autotools ## using `pkgconf` with autotools
@ -71,16 +71,17 @@ do let us know, but also make sure that the .pc files are valid and follow the r
the [pkg-config tutorial][fd-tut], as most likely fixing them to follow the specified the [pkg-config tutorial][fd-tut], as most likely fixing them to follow the specified
rules will solve the problem. rules will solve the problem.
Additionally, **we do not consider pkgconf doing what you tell it to do, when pkg-config Additionally, **we do not consider pkgconf doing what you tell it to do, in cases for
fails to do so, to be a bug**. which pkg-config fails to do so, to be a bug**.
If, for example, you use environment variables such as `PKG_CONFIG_SYSTEM_[INCLUDE|LIBRARY]_PATH` If, for example, you use environment variables such as `PKG_CONFIG_SYSTEM_[INCLUDE|LIBRARY]_PATH`
and then find yourself surprised that `pkgconf` is stripping `-I` and `-L` flags relating and then find yourself surprised that `pkgconf` is stripping `-I` and `-L` flags relating
to those paths, it's not a `pkgconf` problem -- `pkgconf` is doing exactly what you told to those paths, it is not a `pkgconf` problem -- `pkgconf` is doing exactly what you told
it to do. it to do.
We will reject bugs like this, and if you choose to violate our [Code of Conduct](CODE_OF_CONDUCT.md) We will reject bugs like this, and if someone insists on fixing such a non-bug, this
by demanding we fix your non-bug, we will fix the problem by banning you from the repo instead. constitutes a violation of our [Code of Conduct](CODE_OF_CONDUCT.md), which may be
addressed by banning from this repository.
## compiling `pkgconf` and `libpkgconf` on UNIX ## compiling `pkgconf` and `libpkgconf` on UNIX
@ -106,8 +107,8 @@ flags like so:
## compiling `pkgconf` and `libpkgconf` with CMake (usually for Windows) ## compiling `pkgconf` and `libpkgconf` with CMake (usually for Windows)
pkgconf is compiled using CMake on Windows. In theory, you could also use CMake to build pkgconf is compiled using CMake on Windows. In theory, you could also use CMake to build
on UNIX, but this is not recommended at this time as it pkgconf is typically built much earlier on UNIX, but this is not recommended at this time as it pkgconf is typically built much
than CMake. earlier than CMake.
$ mkdir build $ mkdir build
$ cd build $ cd build