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

fix: address latest norminette v3.3.55 update incompatibility issue #80

Merged
merged 3 commits into from
Apr 4, 2024

Conversation

ygor-sena
Copy link
Collaborator

@ygor-sena ygor-sena commented Apr 4, 2024

The latest norminette v3.3.55 doesn't allow students to choose between the K&R or Allman indentation style; instead, it enforces the use of the latter. The K&R indentation style is used in the original Unix kernel, while the Allman style is used in BSD Unix.

Deciding whether to pin the tools used on CD/CI or to keep them updated is a complex question. We must consider factors such as stability versus being up-to-date, security, long-term maintenance, and compatibility. Therefore, I opted for a balanced approach, pinning the Norminette version to v3.3.51, which was the latest version at the time this project was developed and its only major tool.

Since the project is finished, it doesn't require long-term maintenance, nor will it have major security issues since the tool used is only a code formatter. Therefore, I addressed the issue of compatibility as our whole project is structured to adhere to norminette v3.3.51.

However, while I was at it, I decided to make some minor changes to the code to conform to the new norm and only left the critical ones. The norminette v3.3.55 is stricter than the old one regarding preprocessor definitions. The log below references the file include/hash_table.h:

# define RIP ((void *)1)

Error: PREPROC_CONSTANT     (line:  19, col:  14):      Preprocessor statement must only contain constant defines

To sum up, this PR ensures that our CI/CD doesn't break due to external changes if we further tinker with this hard and amusing project.

@ygor-sena ygor-sena added the enhancement New feature or request label Apr 4, 2024
@ygor-sena ygor-sena self-assigned this Apr 4, 2024
@ygor-sena ygor-sena requested a review from magalhaesm April 4, 2024 16:14
Copy link
Owner

@magalhaesm magalhaesm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm!

@magalhaesm magalhaesm merged commit 6339445 into main Apr 4, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants