Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for clang-format #2907

Merged
merged 2 commits into from
Oct 31, 2024

Conversation

mikee47
Copy link
Contributor

@mikee47 mikee47 commented Oct 31, 2024

This PR updates the Sming coding style documentation as discussed in #2898 (comment) and #2904 (comment).

Sming requires version 8 which is generally no longer available in the standard repositories for recent GNU/Linux distributions. Different versions of clang-format produce different output with the same configuration. This is such a common problem that a kind soul has provided standalone builds here https://github.com/muttleyxd/clang-tools-static-binaries/releases.

The default name of the clang-format executable has been changed to clang-format-8. This is because clang-format is now very unlikely to be the default installed version, and so avoids the subtle issues with running the wrong version.

@mikee47 mikee47 marked this pull request as draft October 31, 2024 11:45
Copy link

what-the-diff bot commented Oct 31, 2024

PR Summary

  • Improved the installation process
    This pull request includes detailed instructions for installing clang-format, making the process easier for users. This includes a specific workaround to handle any issues with obtaining version 8.
  • Provided examples for setup
    We provided a set of example commands that help users set up clang-format from standalone binaries.
  • Clarified the usage of CLANG_FORMAT
    We've elaborated on why you need to save the CLANG_FORMAT environment variable for Sming's operation. The default has been changed from clang-format to clang-format-8.
  • Enhanced content arrangement
    The markdown headings have been rearranged to improve content structure. The clang-format section has been moved to its own header for better organization.
  • Facilitated clang-tidy installation
    The PR has added instructions for the installation of clang-tidy on Ubuntu, offering increased clarity on how to implement this install.
  • Updated specification for supported versions
    The PR updates the note detailing the recommended clang-tidy version. It now encourages the use of the most recent version for optimized performance.

@slaff slaff added this to the 6.0.0 milestone Oct 31, 2024
@mikee47 mikee47 marked this pull request as ready for review October 31, 2024 19:50
@slaff slaff merged commit 20b4865 into SmingHub:develop Oct 31, 2024
32 checks passed
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