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

Document why, when and how to update magic numbers #7599

Closed
vicuna opened this issue Jul 25, 2017 · 3 comments
Closed

Document why, when and how to update magic numbers #7599

vicuna opened this issue Jul 25, 2017 · 3 comments

Comments

@vicuna
Copy link

vicuna commented Jul 25, 2017

Original bug ID: 7599
Reporter: @gasche
Status: acknowledged (set by @xavierleroy on 2017-09-21T08:32:40Z)
Resolution: open
Priority: low
Severity: text
Target version: 4.07.0+dev/beta2/rc1/rc2
Category: documentation
Tags: junior_job
Related to: #7598 #7600

Bug description

Currently external contributors may not know about magic numbers, when to update them, and what is the process to update them (in particular, I believe that a bootstrap is needed?).

This could be explained in comments in utils/config.mlp (I like having documentation close to the code) or maybe in utils/HACKING.adoc.

@vicuna
Copy link
Author

vicuna commented Oct 13, 2017

Comment author: @alainfrisch

Cf discussion on #1402 . In particular, Xavier suggested the following scheme:

@damiendoligez and I were discussing an even more radical solution: just
derive the magic numbers from the version number, e.g. CamlTMMmmpp, where T
identifies the type of file, MM the major version number, mm the minor
version number, and pp the patchlevel. No more bumping necessary!

@github-actions
Copy link

This issue has been open one year with no activity. Consequently, it is being marked with the "stale" label. What this means is that the issue will be automatically closed in 30 days unless more comments are added or the "stale" label is removed. Comments that provide new information on the issue are especially welcome: is it still reproducible? did it appear in other contexts? how critical is it? etc.

@github-actions github-actions bot added the Stale label Feb 26, 2021
@Octachron
Copy link
Member

The magic numbers have been documented in utils/HACKING.adoc. (Improvements are always possible)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants