Document pkg-config - #205
Merged
Merged
Conversation
There was a problem hiding this comment.
🔵 Needs a closer look
A moderate documentation issue and a path correction remain unresolved.
Pull request overview
Documents YAZ’s pkg-config metadata, installation paths, and usage while retaining legacy yaz-config guidance.
Changes:
- Documents generated
.pcfiles and install locations. - Adds
pkg-configusage examples and dependency guidance. - Clarifies legacy
yaz-configusage.
File summaries
| File | Summary |
|---|---|
doc/book.xml |
Adds pkg-config documentation and installation details. Findings: 1 moderate issue and 1 nit. |
Review details
Suppressed comments (2)
doc/book.xml:762
- The generated-artifacts list still identifies the legacy script as
util/yaz-config, but Autotools generates and installssrc/yaz-config(src/Makefile.am:6-8,configure.ac:417-427). With this new pkg-config documentation, the page remains internally inconsistent and points readers to a nonexistent path; update that adjacent entry tosrc/yaz-config.
<varlistentry>
<term><filename>yaz.pc</filename>,
<filename>yaz-icu.pc</filename>,
<filename>yaz-server.pc</filename></term>
doc/book.xml:963
- This recommendation is not valid for a
--without-xml2build:yaz.pcunconditionally declaresRequires: libexslt, even though XML/EXSLT support is optional (configure.ac:355-370,doc/book.xml:643-654). On a system withoutlibexslt.pc, both example commands fail before returning YAZ's flags. Make the.pcdependency conditional on the configured features, or qualify this guidance for XML-enabled builds.
Use <command>pkg-config</command> to obtain the compiler and linker
flags for applications using &yaz;. The installed packages are
<literal>yaz</literal> for the main library,
<literal>yaz-icu</literal> for the ICU wrapper library, and
<literal>yaz-server</literal> for the Generic Frontend server library.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.