[0/2] Documentation: add glossary terms
mbox series

Message ID 20251219-glossary-page-v1-0-971ba0ab4b2f@schnwalter.eu
Headers show
Series
  • Documentation: add glossary terms
Related show

Message

Walter Werner Schneider Dec. 19, 2025, 7:06 p.m. UTC 
This patch set adds a glossary page that currently contains acronyms and
abbreviations that are relevant to libcamera developers. It also
includes terms that are not directly used by libcamera but are used in
datasheets or other relevant projects such as the Linux kernel.

I'm thinking that in the future this glossary page can be extended to
also explain various technical terms, instead of sprinkling them all
over various pages. I'll provide some examples in an future patch set.

I've added a 2nd commit that basically provides an example on how to
link to terms from other pages. Note that term links must be separated
from other text by whitespace or punctuation.

Signed-off-by: Walter Werner Schneider <contact@schnwalter.eu>
---
Walter Werner Schneider (2):
      Documentation: add glossary page
      Documentation: Link to glossary terms from the introduction page

 Documentation/glossary.rst     | 158 +++++++++++++++++++++++++++++++++++++++++
 Documentation/index.rst        |   1 +
 Documentation/introduction.rst |  10 +--
 Documentation/meson.build      |   1 +
 4 files changed, 165 insertions(+), 5 deletions(-)
---
base-commit: 2861817f09c96a0660b88783eff159631e42030f
change-id: 20251219-glossary-page-beedde742b9d

Best regards,