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

Split index into multiple parts and add automated document check #241

Merged
merged 4 commits into from
Jun 16, 2020

Conversation

jjhursey
Copy link
Member

@jjhursey jjhursey commented Jun 9, 2020

  • Multiple indices will make it easier to find APIs vs attributes vs ...
  • Add an automated document cross-check against OpenPMIx
    • Checks PMIx Standard items not included in OpenPMIx
    • Checks OpenPMIx items not included in PMIx Standard

Closes #149

@jjhursey jjhursey added the WorkInProgress Work In Progress label Jun 9, 2020
@jjhursey
Copy link
Member Author

jjhursey commented Jun 9, 2020

Ref Issue #149 - this will generate .idx files that can be used to access the attributes/apis/macros/constants/structs from the standard. That will be useful when building the document checker.

Keeping this a WIP for now as I work on the document checker script.

@jjhursey jjhursey changed the title Split index into multiple parts Split index into multiple parts and add automated document check Jun 11, 2020
@jjhursey
Copy link
Member Author

PDF rendering of the current state of the PR (so you can see the indexing)
pmix-standard-pr-241-v2.pdf

@jjhursey jjhursey removed the WorkInProgress Work In Progress label Jun 11, 2020
@jjhursey jjhursey marked this pull request as ready for review June 11, 2020 17:49
@jjhursey
Copy link
Member Author

I plan to discuss the indexing changes in the PMIx Standard meeting on Friday, June 11. So I won't plan to merge before then.

This is missing one optional feature of (we don't need it right now so we can wait on it)

  • Whitelisting of items that are ok to be missing on either side (e.g., something in OpenPMIx that is not meant to be part of the PMIx Standard or vise versa)

@jjhursey jjhursey added this to the PMIx v4 Standard milestone Jun 11, 2020
@SteVwonder
Copy link
Contributor

Very nice @jjhursey! I wonder if we can leverage this work to improve the coverage analysis and cleanup some of the inconsistencies that @rhc54 pointed out.

@jjhursey
Copy link
Member Author

Per teleconf June 12, 2020

  • Can we remove the Definition line, and instead have a bolded page number at the front of the reference list? That would compress the index a bit, and still preserve meaning.
  • Generally like the breakdown in the current index. Generally ok with the mix of double and single-column format.

jjhursey added 4 commits June 15, 2020 16:00
 * Multiple indices will make it easier to find APIs vs attributes vs ...
 * This is also a first step to an automatic document checker

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
 * `make check-openpmix` target

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
 * This allows the binding to nest under the main definition in the index

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
@jjhursey
Copy link
Member Author

pmix-standard.pdf

This version uses bold and underlining to denote the Definition in the index (instead of a separate Definition line). I moved all the indices to single column as that helped scanning down the list for a given item.

I think this is ready for review for inclusion in v4.

@jjhursey jjhursey requested a review from rhc54 June 15, 2020 21:03
Copy link
Member

@rhc54 rhc54 left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks!

@rhc54 rhc54 merged commit e4d7b6e into pmix:master Jun 16, 2020
@jjhursey jjhursey deleted the index-split branch June 16, 2020 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automated document checker
3 participants