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

Add an Attribute declared but not referenced script #225

Merged
merged 1 commit into from
Nov 14, 2019

Conversation

jjhursey
Copy link
Member

 * Adds a script to list all of the attributes that have been declared
   but have no reference in the document outside of the declaration.
 * Fixes a typo in the internal cross referencing
 * Add a new make target `make check` that runs this additional check
   and displays the list of attributes missing a reference.
 * Ref Issue pmix#185

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
(cherry picked from commit a5f3bf1)
@jjhursey jjhursey added this to the PMIx v3.2 Standard milestone Sep 30, 2019
@jjhursey jjhursey requested a review from rhc54 September 30, 2019 17:39
@jjhursey
Copy link
Member Author

This is probably useful to have in the v3 standard as an option as well.

Here is the report out for the v3 branch:

$$ make check
====> Checking for Attributes Declared, but not referenced
Attribute Missing Reference: PMIX_ATTR_UNDEF
Attribute Missing Reference: PMIX_RECONNECT_SERVER
Attribute Missing Reference: PMIX_TOPOLOGY_FILE
Attribute Missing Reference: PMIX_LOCALITY_STRING
Attribute Missing Reference: PMIX_PROC_BLOB
Attribute Missing Reference: PMIX_ARCH
Attribute Missing Reference: PMIX_DEBUG_APP_DIRECTIVES
Attribute Missing Reference: PMIX_SERVER_ENABLE_MONITORING
Attribute Missing Reference: PMIX_DEBUG_STOP_ON_EXEC
Attribute Missing Reference: PMIX_RM_VERSION
Attribute Missing Reference: PMIX_NOTIFY_COMPLETION
Attribute Missing Reference: PMIX_IOF_COMPLETE
Attribute Missing Reference: PMIX_CLIENT_AVG_MEMORY
Attribute Missing Reference: PMIX_EVENT_TEXT_MESSAGE
Attribute Missing Reference: PMIX_SEND_HEARTBEAT
Attribute Missing Reference: PMIX_HWLOC_SHARE_TOPO
Attribute Missing Reference: PMIX_CREDENTIAL
Attribute Missing Reference: PMIX_SET_ENVAR
Attribute Missing Reference: PMIX_HWLOC_SHMEM_FILE
Attribute Missing Reference: PMIX_THREADING_MODEL
Attribute Missing Reference: PMIX_DAEMON_MEMORY
Attribute Missing Reference: PMIX_UNSET_ENVAR
Attribute Missing Reference: PMIX_TOPOLOGY
Attribute Missing Reference: PMIX_NET_TOPO
Attribute Missing Reference: PMIX_CRYPTO_KEY
Attribute Missing Reference: PMIX_EXIT_CODE
Attribute Missing Reference: PMIX_MODEL_NUM_CPUS
Attribute Missing Reference: PMIX_APPEND_ENVAR
Attribute Missing Reference: PMIX_VERSION_INFO
Attribute Missing Reference: PMIX_APP_MAP_REGEX
Attribute Missing Reference: PMIX_MODEL_AFFINITY_POLICY
Attribute Missing Reference: PMIX_CPUSET
Attribute Missing Reference: PMIX_PROC_PID
Attribute Missing Reference: PMIX_EVENT_PROXY
Attribute Missing Reference: PMIX_RM_NAME
Attribute Missing Reference: PMIX_HWLOC_HOLE_KIND
Attribute Missing Reference: PMIX_ADD_ENVAR
Attribute Missing Reference: PMIX_TDIR_RMCLEAN
Attribute Missing Reference: PMIX_DEBUG_WAIT_FOR_NOTIFY
Attribute Missing Reference: PMIX_ANL_MAP
Attribute Missing Reference: PMIX_TOPOLOGY_SIGNATURE
Attribute Missing Reference: PMIX_HWLOC_SHMEM_SIZE
Attribute Missing Reference: PMIX_MAP_BLOB
Attribute Missing Reference: PMIX_EVENT_NO_TERMINATION
Attribute Missing Reference: PMIX_SERVER_HOSTNAME
Attribute Missing Reference: PMIX_DEBUG_STOP_IN_INIT
Attribute Missing Reference: PMIX_LOCAL_TOPO
Attribute Missing Reference: PMIX_MODEL_NUM_THREADS
Attribute Missing Reference: PMIX_SPAWN_TOOL
Attribute Missing Reference: PMIX_LOG_EMAIL_SERVER
Attribute Missing Reference: PMIX_PROGRAMMING_MODEL
Attribute Missing Reference: PMIX_PROCDIR
Attribute Missing Reference: PMIX_CLUSTER_ID
Attribute Missing Reference: PMIX_LAUNCHER
Attribute Missing Reference: PMIX_EVENT_DO_NOT_CACHE
Attribute Missing Reference: PMIX_MODEL_LIBRARY_NAME
Attribute Missing Reference: PMIX_DEBUG_JOB_DIRECTIVES
Attribute Missing Reference: PMIX_COSPAWN_APP
Attribute Missing Reference: PMIX_PREPEND_ENVAR
Attribute Missing Reference: PMIX_MODEL_PHASE_TYPE
Attribute Missing Reference: PMIX_MODEL_LIBRARY_VERSION
Attribute Missing Reference: PMIX_EVENT_WANT_TERMINATION
Attribute Missing Reference: PMIX_DSTPATH
Attribute Missing Reference: PMIX_SERVER_GATEWAY
Attribute Missing Reference: PMIX_LOCALITY
Attribute Missing Reference: PMIX_LOG_EMAIL_SENDER_ADDR
Attribute Missing Reference: PMIX_MODEL_CPU_TYPE
Attribute Missing Reference: PMIX_QUERY_AUTHORIZATIONS
Attribute Missing Reference: PMIX_MODEL_PHASE_NAME
Attribute Missing Reference: PMIX_JOB_TERM_STATUS
Attribute Missing Reference: PMIX_DEBUG_JOB
Attribute Missing Reference: PMIX_NODE_LIST
Attribute Missing Reference: PMIX_HWLOC_SHMEM_ADDR
Attribute Missing Reference: PMIX_PROC_STATE_STATUS
Attribute Missing Reference: PMIX_APP_MAP_TYPE
Attribute Missing Reference: PMIX_DEBUG_WAITING_FOR_NOTIFY
Attribute Missing Reference: PMIX_LOG_EMAIL_SRVR_PORT
Attribute Missing Reference: PMIX_TOPOLOGY_XML
 78 of 325 Attributes are missing reference
make: *** [check] Error 78

@jjhursey
Copy link
Member Author

Cherry Pick of PR #223

@jjhursey
Copy link
Member Author

@rhc54 can you give this a 👍 and merge for the v3.x branch? That way we have the script over there too if we need it.

@rhc54 rhc54 merged commit 8ef249b into pmix:v3 Nov 14, 2019
@jjhursey jjhursey deleted the v3-attr-check branch November 14, 2019 16:35
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.

2 participants