Updated documentation for adding additional io #218
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
glennchid
approved these changes
Oct 21, 2024
| @@ -82,6 +84,12 @@ configuration. | |||
| If the ``extension`` field is present then the ``extensions`` directory in the | |||
| module must exist and contain a python server extension file. | |||
|
|
|||
| If the ``extra_interface`` field is present then this block would enable use of | |||
| the specified io. This io would also need to have been identified as a capability | |||
| and signified with a '*' in the :ref:`Target ini`. THe build system would then | |||
| and signified with a '*' in the :ref:`Target ini`. THe build system would then | ||
| enable this io as if it were specified in the ``io`` section of the target.ini, | ||
| up to the lower numer specified here or in the target.ini. | ||
|
|
There was a problem hiding this comment.
where the number of instances is determined by the lower of the number specified here or that given in the target.ini file.
|
|
||
| The ``io`` type describes the IO that is available on the target. The format is | ||
| ``io_name: io_type, number``. If ``io_type`` is not specified it is assumed | ||
| to be the same as ``io_name``. If there is a '*' in ``number`` the target has the |
There was a problem hiding this comment.
If there is a '*' following number
| @@ -284,12 +292,20 @@ The first entry to the ini file defines information for the SFP sites for the | |||
| target:: | |||
There was a problem hiding this comment.
Also, change 'SFP' to 'IO' in
The [.] section
~~~~~~~~~~~~~~~
The first entry to the ini file defines information for the SFP sites for the
I think it is okay, though a few minor suggestions above. Might be better though to get somebody not familiar with the changes to review and see if it is understandable. |
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.
resolves #193.
@glennchid Would you say this description is easy to follow? I'm wondering if it doesn't read that well - I'm happy to re-write it.