Skip to content

Normalize naming: mu::tiny brand, mu.tiny package, mu/tiny/ includes#60

Merged
thetic merged 6 commits into
mainfrom
nom-de-guerre
Apr 18, 2026
Merged

Normalize naming: mu::tiny brand, mu.tiny package, mu/tiny/ includes#60
thetic merged 6 commits into
mainfrom
nom-de-guerre

Conversation

@thetic
Copy link
Copy Markdown
Owner

@thetic thetic commented Apr 18, 2026

Description

Establishes the canonical naming convention across all surfaces of the project, motivated by a future where additional mu:: libraries may exist alongside mu::tiny.

Surface Before After
Branding / docs Mu::tiny mu::tiny
CMake module include(Mutiny) include(mu.tiny)
CMake package find_package(mutiny) find_package(mu.tiny)
FetchContent FetchContent_Declare(mutiny ...) FetchContent_Declare(mu.tiny ...)
C++ includes #include "mutiny/test.hpp" #include "mu/tiny/test.hpp"
C includes #include "mutiny/test.h" #include "mu/tiny/test.h"
CMake internal target mutiny mutiny (unchanged)
CMake export target mu::tiny mu::tiny (unchanged)
Library name libmutiny.a libmutiny.a (unchanged)
C names mutiny_* mutiny_* (unchanged)

Changes land in three commits, each building and passing all tests before the next:

  1. Rename CMake modulecmake/Mutiny.cmakecmake/mu.tiny.cmake
  2. Rename CMake package — config files, export set, and FetchContent name → mu.tiny
  3. Rename include pathsinclude/mutiny/include/mu/tiny/, include guards INCLUDED_MUTINY_INCLUDED_MU_TINY_, Doxygen INPUT, .clang-format categories

Related Issues

None

Type of Change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • I have written/updated documentation in docs/ for any user-facing changes.
  • My code follows the project's naming conventions (mu::tiny namespace, INCLUDED_MU_TINY_ guards, mutiny_ C-prefix).
  • For new features, I have considered if a C-interface adapter (.h and .c.cpp) is required for parity.
  • I have reviewed the CONTRIBUTING.md file to ensure compliance with architectural guidelines.

@coveralls
Copy link
Copy Markdown

coveralls commented Apr 18, 2026

Coverage Status

coverage: 98.867%. remained the same — nom-de-guerre into main

@thetic thetic force-pushed the nom-de-guerre branch 2 times, most recently from 9c46dc9 to fd890d5 Compare April 18, 2026 01:47
thetic added 2 commits April 17, 2026 19:00
include(mu.tiny) now loads cmake/mu.tiny.cmake, matching the project's
canonical naming convention where the CMake module name mirrors the
package name (mu.tiny).
find_package(mu.tiny) and FetchContent_Declare(mu.tiny ...) now match
the canonical package name. Config files are renamed mu.tiny-config.cmake
and mu.tiny-configVersion.cmake; the export set is mu.tiny-Targets.
@thetic thetic changed the title Rename CMake module Mutiny → mu.tiny Normalize naming: mu::tiny brand, mu.tiny package, mu/tiny/ includes Apr 18, 2026
@thetic thetic marked this pull request as ready for review April 18, 2026 02:05
thetic added 3 commits April 17, 2026 19:10
#include "mu/tiny/test.hpp" and #include "mu/tiny/mock.h" are now the
canonical include paths, matching the C++ namespace mu::tiny and the
package name mu.tiny. Include guards update from INCLUDED_MUTINY_* to
INCLUDED_MU_TINY_*; clang-format categories track the new prefix.
Prose, headings, and RST titles all use mu::tiny rather than Mu::tiny,
matching the canonical all-lowercase form from the naming table.
String.hpp, features.hpp, time.hpp (include/mu/tiny/) and
StringCollection.hpp (src/mu/tiny/) sit directly under mu/tiny/, not
inside the test/ subdirectory. Their guards incorrectly carried
INCLUDED_MU_TINY_TEST_* (inherited from the original MUTINY_TEST_*
guards). Corrected to INCLUDED_MU_TINY_*.
@thetic thetic merged commit 7e8ed5c into main Apr 18, 2026
40 checks passed
@thetic thetic deleted the nom-de-guerre branch April 18, 2026 02:21
thetic added a commit that referenced this pull request Apr 18, 2026
Update FetchContent name, include(Mutiny), find_package, header paths,
and #include examples to match the mu.tiny naming established in #60.
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.

2 participants