doc: document config/library.csv, following doc/config/constants.md - #1733
Open
Wiljea wants to merge 1 commit into
Open
doc: document config/library.csv, following doc/config/constants.md#1733Wiljea wants to merge 1 commit into
Wiljea wants to merge 1 commit into
Conversation
evgaster asked for this on c3d#1722, on the model of his own c3d#1703, as the thing that would stop the next contributor walking into the same trap. It documents the format and the three ways a value is read, and then the three traps that this library has already paid for. File names must be ASCII. The label may be anything, but FatFs cannot open a file whose name is not, and the entry then fails with "Invalid or unknown library entry", or, when it is reached from an equation, with "Root error: Unable to solve for all variables". The bare "=" form is where this bites, since it takes the file name from the entry name: 42 of 93 programs were unusable on a DM32 that way, and every one of them worked on the simulator. The order of the file matters. Entries are numbered by position and Attach takes those numbers; top-level sections take the soft keys of the Lib menu in file order, so inserting one moves the sections below it and src/tests.cc has to follow. That is why the library test went from F3 to F4 and then to F5. Files in subdirectories have to be packaged. The Makefile ships one level of subdirectory, so a program two levels down is named by library.csv and never shipped. doc/config/ is not in HELP_SOURCES, so this changes neither the help file nor the tests. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
evgaster asked for this on #1722, on the model of his own #1703, as the thing that would stop the next contributor walking into the same trap. It documents the format and the three ways a value is read, and then the three traps that this library has already paid for.
File names must be ASCII. The label may be anything, but FatFs cannot open a file whose name is not, and the entry then fails with "Invalid or unknown library entry", or, when it is reached from an equation, with "Root error: Unable to solve for all variables". The bare "=" form is where this bites, since it takes the file name from the entry name: 42 of 93 programs were unusable on a DM32 that way, and every one of them worked on the simulator.
The order of the file matters. Entries are numbered by position and Attach takes those numbers; top-level sections take the soft keys of the Lib menu in file order, so inserting one moves the sections below it and src/tests.cc has to follow. That is why the library test went from F3 to F4 and then to F5.
Files in subdirectories have to be packaged. The Makefile ships one level of subdirectory, so a program two levels down is named by library.csv and never shipped.
doc/config/ is not in HELP_SOURCES, so this changes neither the help file nor the tests.