Skip to content

Rationalise file and header organisation in preparation for potential C++ library - #1062

Merged
tturocy merged 1 commit into
masterfrom
dev_libraryprep
Aug 19, 2026
Merged

tturocy merged 1 commit into
masterfrom
dev_libraryprep

Conversation

@tturocy

@tturocy tturocy commented Aug 19, 2026

Copy link
Copy Markdown
Member

We are not yet prepared to commit to offering a separate C++ library, but it is on the roadmap. That aside, being consistent internally with organisation of header files and conceptual modules is useful.

This commit:

  • Sets rules for the structure of including header files, especially avoiding tacit inclusion.
  • Updates include guards and filenames in comments to clear up historical drift.
  • Organises the C++ build to use autotools' convenience libraries.
  • Adds some developer documentation memorialising the key conventions to follow to enable library builds down the line.

… C++ library

We are not yet prepared to commit to offering a separate C++ library, but it is on the roadmap.
That aside, being consistent internally with organisation of header files and conceptual modules is useful.

This commit:
* Sets rules for the structure of including header files, especially avoiding tacit inclusion.
* Updates include guards and filenames in comments to clear up historical drift.
* Organises the C++ build to use autotools' convenience libraries.
* Adds some developer documentation memorialising the key conventions to follow to enable library builds down the line.
@tturocy
tturocy merged commit b56dc64 into master Aug 19, 2026
26 checks passed
@tturocy
tturocy deleted the dev_libraryprep branch August 19, 2026 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant