Documentation fixes part 2 #11578
Merged
Documentation fixes part 2 #11578
Conversation
This file contains 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
|
There is another issues in the docs. There are 2 headers titled |
cuavas
reviewed
Oct 1, 2023
Comment on lines
197
to
200
| There currently is no way for the debugger GUI to add per-core | ||
| configuration. It is needed for in particular the s2650 and the | ||
| saturn cores. It should go through the cpu core class itself, since | ||
| it's pulled from the config struct. | ||
| configuration. It is particularly needed for the s2650 and Saturn | ||
| cores. It should go through the cpu core class itself, since it's | ||
| pulled from the config struct. |
There was a problem hiding this comment.
This is a result of French grammar leaking into English ;)
It would be better phrased as “In particular, it is needed for the s2650…”
docs/source/techspecs/floppy.rst
Outdated
| Writing encoded data is easy, you only need a clock at the appropriate frequency and send or not a pulse on the clock edges. Reading back the data is where the fun is. Cells are a logical construct and not a physical measurable entity. Rotational speeds very around the defined one (+/- 2% is not rare) and local perturbations (air turbulence, surface distance...) make the instant speed very variable in general. So to extract the cell values stream the controller must dynamically synchronize with the pulse train that the floppy head picks up. The principle is simple: a cell-sized duration window is build within which the presence of at least one pulse indicates the cell is a '1', and the absence of any a '0'. After reaching the end of the window the starting time is moved appropriately to try to keep the observed pulse at the exact middle of the window. This allows to correct the phase on every '1' cell, making the synchronization work if the rotational speed is not too off. Subsequent generations of controllers used a Phase-Locked Loop (PLL) which vary both phase and window duration to adapt better to wrong rotational speeds, with usually a tolerance of +/- 15%. | ||
| Writing encoded data is easy, you only need a clock at the appropriate frequency and send or not a pulse on the clock edges. Reading back the data is where the fun is. Cells are a logical construct and not a physical measurable entity. Rotational speeds very around the defined one (+/- 2% is not rare) and local perturbations (air turbulence, surface distance...) make the instant speed very variable in general. So to extract the cell values stream the controller must dynamically synchronize with the pulse train that the floppy head picks up. The principle is simple: a cell-sized duration window is built within which the presence of at least one pulse indicates the cell is a '1', and the absence of any a '0'. After reaching the end of the window the starting time is moved appropriately to try to keep the observed pulse at the exact middle of the window. This allows to correct the phase on every '1' cell, making the synchronization work if the rotational speed is not too off. Subsequent generations of controllers used a Phase-Locked Loop (PLL) which vary both phase and window duration to adapt better to wrong rotational speeds, with usually a tolerance of +/- 15%. |
There was a problem hiding this comment.
This could do with some more commas.
Comment on lines
117
to
118
| * **Relative analog fields** have a range with with defined | ||
| minimum, maximum and starting positions. On each update, the value | ||
| * **Relative analog fields** have a range with a defined minimum, | ||
| maximum and starting positions. On each update, the value |
There was a problem hiding this comment.
The “a” is misplaced, it should just be “…with defined minimum, maximum and starting positions.”
Comment on lines
399
to
400
| screens, to make up a view. Elements may be built up one or more *components*, | ||
| but an element is treated as as single surface when building the scene graph | ||
| screens, to make up a view. Elements may be built up by one or more *components*, | ||
| but an element is treated as a single surface when building the scene graph |
There was a problem hiding this comment.
Should be “built up of one or more components.”
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Various typos & other grammar fixes.