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.

Sign up for GitHub

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

Jump to bottom

Split TribitsDevelopersGuide.* into TribitsUsersGuide.* and TribitsMaintainersGuide.* #381

Closed
bartlettroscoe opened this issue Jun 21, 2021 · 2 comments
Closed

Split TribitsDevelopersGuide.* into TribitsUsersGuide.* and TribitsMaintainersGuide.* #381

bartlettroscoe opened this issue Jun 21, 2021 · 2 comments
Labels
component: documentation type: enhancement
Projects
TriBITS Refactor

Comments

@bartlettroscoe
Copy link
Member

bartlettroscoe commented Jun 21, 2021 •
edited
Loading

Supports: #377, #63, #299

Description

At the "TriBITS package dependencies data-structure and code walkthrough" meeting last Friday, 6/18/2021 to discuss #377, it was suggested by the NGA staff members to split the document:

  • TribitsDevelopersGuide.*: "TriBITS Developers Guide and Reference"

into two documents:

  • TribitsUsersGuide.*: "TriBITS Users Guide and Reference"
  • TribitsMaintainersGuide.*.: "TriBITS Maintainers Guide and Reference"

The latter TribitsMaintainersGuide.*. will be a superset of the former that includes information about the internal implementation details of TriBITS and will contain file names and line numbers to TriBITS implementation files. The former TribitsUsersGuide.* will be the same but will not have the appendix " TriBITS System Maintainers Guide".
@bartlettroscoe bartlettroscoe created this issue from a note in TriBITS Refactor (Selected) Jun 21, 2021
@bartlettroscoe bartlettroscoe mentioned this issue Jun 21, 2021
Open
16 tasks
@bartlettroscoe bartlettroscoe moved this from Selected to In Progress in TriBITS Refactor Jun 21, 2021
@bartlettroscoe bartlettroscoe mentioned this issue Jun 24, 2021
Closed
2 tasks
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 24, 2021
@bartlettroscoe
Fix some typos in comments (TriBITSPub#381)
f5660f9
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 24, 2021
@bartlettroscoe
Disable generation of TribitsUsersGuide.pdf (TriBITSPub#381)
37e79eb 
pdflatex hangs currently.
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 24, 2021
@bartlettroscoe
Change name to 'guides' (TriBITSPub#381)
4583860
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 24, 2021
@bartlettroscoe
Remove all TribitsDevelopersGuilde.rst and Makefile (TriBITSPub#381)
53d41e1
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Break TribitsDevelopersGuide.* into Users and Maintainers Guides (Tri…
2d851d2 
…BITSPub#381)

Hopefully the structure of the new setup should be obvious but I will explain
some changes here:

* Renamed base dir from 'developers_guide/' to 'guides/'.  The two new
  documents are guides/users_guide/TribitsUsersGuide.rst and
  guides/maintainers_guide/TribitsMaintainersGuide.rst.  (The latter has file
  names and line numbers for all documented macros and functions and the former
  does not.  See updated abstract and Introduction sections in both documents
  for more details.)

* Split up TribitsDevelopersGuide.rst into:
   - TribitsCoreDetailedReference.rst
   - TribitsDesignConsiderations.rst
   - TribitsDevelopersGuide.rst
   - TribitsFAQ.rst
   - TribitsGuidesBody.rst
   - TribitsGuidesReferences.rst
   - TribitsHistory.rst
   - TribitsMacroFunctionDocTemplate.rst
   - TribitsPackageNotCMakePackage.rst
   - TribitsToolsDocumentation.rst

* Fixed up the shared text to work for both documents.

* Renamed driver generate-dev-guide.sh to generate-guides.sh and take
  arguments 'all' or 'md' or 'ug'.
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Disable generation of TribitsUsersGuide.pdf (TriBITSPub#381)
f137d58 
pdflatex hangs currently.
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Remove old files TribitsDevelopersGuilde.rst and Makefile (TriBITSPub…
6392699 
…#381)

These are not needed anymore.  All of this has been transitioned to other
files in the new documents.
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
SQUASH AGAINST: Break TribitsDevelopersGuide.* into Users and Maintai…
5b212cb 
…ners Guides (TriBITSPub#381)
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Update reference to TribitsUsersGuide.html (TriBITSPub#381)
daba1c4
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Break TribitsDevelopersGuide.* into Users and Maintainers Guides (Tri…
fd7d3aa 
…BITSPub#381)

Hopefully the structure of the new setup should be obvious but I will explain
some changes here:

* Renamed base dir from 'developers_guide/' to 'guides/'.  The two new
  documents are guides/users_guide/TribitsUsersGuide.rst and
  guides/maintainers_guide/TribitsMaintainersGuide.rst.  (The latter has file
  names and line numbers for all documented macros and functions and the former
  does not.  See updated abstract and Introduction sections in both documents
  for more details.)

* Split up TribitsDevelopersGuide.rst into:
   - TribitsCoreDetailedReference.rst
   - TribitsDesignConsiderations.rst
   - TribitsDevelopersGuide.rst
   - TribitsFAQ.rst
   - TribitsGuidesBody.rst
   - TribitsGuidesReferences.rst
   - TribitsHistory.rst
   - TribitsMacroFunctionDocTemplate.rst
   - TribitsPackageNotCMakePackage.rst
   - TribitsToolsDocumentation.rst

* Fixed up the shared text to work for both documents.

* Renamed driver generate-dev-guide.sh to generate-guides.sh and take
  arguments 'all' or 'md' or 'ug'.
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Disable generation of TribitsUsersGuide.pdf (TriBITSPub#381)
7b6a93c 
pdflatex hangs currently.
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Remove old files TribitsDevelopersGuilde.rst and Makefile (TriBITSPub…
f0a24ba 
…#381)

These are not needed anymore.  All of this has been transitioned to other
files in the new documents.
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Update reference to TribitsUsersGuide.html (TriBITSPub#381)
0a06166
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Update link to TribitsUsersGuide.html and change to *.md file (TriBIT…
59e9da8 
…SPub#381)
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 25, 2021
@bartlettroscoe
Update links for guides rename and TribitsUsersGuide.* (TriBITSPub#381)
518cbff
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 26, 2021
@bartlettroscoe
Update link to TribitsUsersGuide.html and change to *.md file (TriBIT…
6941333 
…SPub#381)
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 26, 2021
@bartlettroscoe
Update links for guides rename and TribitsUsersGuide.* (TriBITSPub#381)
a193b8c
@bartlettroscoe bartlettroscoe mentioned this issue Jun 26, 2021
Merged
bartlettroscoe added a commit that referenced this issue Jun 26, 2021
@bartlettroscoe
Merge branch '381-split-tribits-dev-guide' (#381)
67bea04 
Build/Test Cases Summary
Enabled Packages:
Enabled all Packages
0) MPI_DEBUG => Test case MPI_DEBUG was not run! => Does not affect push readiness! (-1.00 min)
1) SERIAL_RELEASE => Test case SERIAL_RELEASE was not run! => Does not affect push readiness! (-1.00 min)
2) MPI_DEBUG_CMake-3.17.0 => passed: passed=374,notpassed=0 (1.50 min)
3) SERIAL_RELEASE_CMake-3.17.0 => passed: passed=374,notpassed=0 (1.62 min)
4) MPI_DEBUG_CMake-3.17.0_Python-3.5.2 => passed: passed=374,notpassed=0 (1.67 min)
Other local commits for this build/test group: a193b8c, 6941333, 0a06166, 30855db, f0a24ba, 7b6a93c, fd7d3aa
@bartlettroscoe bartlettroscoe moved this from In Progress to In Review in TriBITS Refactor Jun 26, 2021
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 26, 2021
@bartlettroscoe
Replace last few references to TribitsDevelopersGuide.html (TriBITSPu…
df378c7 
…b#381)
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 26, 2021
@bartlettroscoe
Replace last few references to TribitsDevelopersGuide.html (TriBITSPu…
7e8f91a 
…b#381)

Also point to more specific place in documents
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 26, 2021
@bartlettroscoe
Replace last few references to TribitsDevelopersGuide.html (TriBITSPu…
64cd6f0 
…b#381)

Also point to more specific place in documents
bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jun 26, 2021
@bartlettroscoe
Replace last few references to TribitsDevelopersGuide.html (TriBITSPu…
112f6b6 
…b#381)

Also point to more specific place in documents
@bartlettroscoe bartlettroscoe mentioned this issue Jun 26, 2021
Merged
bartlettroscoe added a commit that referenced this issue Jun 26, 2021
@bartlettroscoe
Merge branch '381-replace-tribits-developers-guide-refs' (#381)
b91a9d2 
Build/Test Cases Summary
Enabled Packages:
Enabled all Packages
0) MPI_DEBUG => Test case MPI_DEBUG was not run! => Does not affect push readiness! (-1.00 min)
1) SERIAL_RELEASE => Test case SERIAL_RELEASE was not run! => Does not affect push readiness! (-1.00 min)
2) MPI_DEBUG_CMake-3.17.0 => passed: passed=374,notpassed=0 (1.80 min)
3) SERIAL_RELEASE_CMake-3.17.0 => passed: passed=374,notpassed=0 (1.52 min)
4) MPI_DEBUG_CMake-3.17.0_Python-3.5.2 => passed: passed=374,notpassed=0 (1.75 min)
Other local commits for this build/test group: 112f6b6
@bartlettroscoe
Copy link
Member Author

@fnrizzi, @marcinwrobel1986, @keitat, with the merge of PRs #384 and #385 (that can be reviewed post merge), I believe this is complete. See the new documents "TriBITS Users Guide and Reference" and "TriBITS Maintainers Guide and Reference" at https://tribits.org/.

@bartlettroscoe bartlettroscoe moved this from In Review to Done in TriBITS Refactor Jul 8, 2021
@bartlettroscoe bartlettroscoe mentioned this issue Jul 11, 2021
Closed
4 tasks
bartlettroscoe added a commit to bartlettroscoe/Trilinos that referenced this issue Sep 4, 2021
@bartlettroscoe
Merge branch 'tribits_github_snapshot' into tribits-snapshot-2021-09-03
3c77011 
Brings in numerous refactorings to TriBITS over the last 3 months, but there
should be no breaks in backward compatibility.  Almost every file in TriBITS
is changed due to the lower-casing of command, macro and function names in PR
TriBITSPub/TriBITS#379.  But the main driver for this snapshot is to bring in
the change in PR TriBITSPub/TriBITS#413 that should make it so that Kokkos
INTERFACE_COMPILE_OPTIONS get propagated to downstream targets in TriBITS and
therefore to external customers through installed <Package>Config.cmake files
and IMPORTED targets.  I should have done several snapshots in the last few
months and not done a big snapshot like this (but I have been testing with
Trilinos locally along the way).

Overall, this merge brings in changes from a bunch of TriBITS PRs including
(from most recent):

* TriBITSPub/TriBITS#413: Change internal TriBITS target_link_libraries() to
  PUBLIC (TriBITSPub/TriBITS#299) component: core type: enhancement

* TriBITSPub/TriBITS#410: Upgrade from cmake 3.21.0 to 3.21.2
  (TriBITSPub/TriBITS#363, TriBITSPub/TriBITS#394)

* TriBITSPub/TriBITS#394: DO NOT MERGE: Show TriBITS test failures with CMake
  3.21.0 that don't occur with CMake 3.17.5 (TriBITSPub/TriBITS#363)

* TriBITSPub/TriBITS#409: Add getTestDictStatusField() to handle empty
  'status' field (SESW-383) component: ci_support type: enhancement

* TriBITSPub/TriBITS#408: Deal with spaces in CDash url parts (SESW-383)
  component: ci_support type: enhancement

* TriBITSPub/TriBITS#403: Spelling fixes

* TriBITSPub/TriBITS#407: Move tribits_get_build_url_and_write_to_file() to
  stand-alone module (TriBITSPub/TriBITS#154) component: ctest_driver type:
  enhancement

* TriBITSPub/TriBITS#388: Fixing typos (TriBITSPub/TriBITS#377)

* TriBITSPub/TriBITS#406: Fix tribits_ctest_driver() package-by-package mode
  for CMake 3.19+ (TriBITSPub/TriBITS#363, TriBITSPub/TriBITS#394) component:
  ctest_driver type: bug

* TriBITSPub/TriBITS#401: Improve GitHub Actions and CDash integration
  (TriBITSPub/TriBITS#154) type: enhancement

* TriBITSPub/TriBITS#366: CI: draft action yaml

* TriBITSPub/TriBITS#402: Revert some incorrect uppercase->lowercase changes

* TriBITSPub/TriBITS#387: Build and deploy TriBITS documentation with Sphinx
  (TriBITSPub/TriBITS#386) component: documentation type: enhancement

* TriBITSPub/TriBITS#398: Deal with pr null in not preprending build name
  (TriBITSPub/TriBITS#363) type: bug

* TriBITSPub/TriBITS#396: Send PR results to 'Pull Request' CDash group and
  add PR ID to build names (TriBITSPub/TriBITS#363) type: enhancement

* TriBITSPub/TriBITS#397: Print the ninja path and version
  (TriBITSPub/TriBITS#363)

* TriBITSPub/TriBITS#393: GitHub Actions based testing for TriBITS
  (TriBITSPub/TriBITS#363) type: enhancement

* TriBITSPub/TriBITS#389: TriBITS CI testing with GitHub Actions
  (TriBITSPub/TriBITS#363) type: enhancement

* TriBITSPub/TriBITS#392: Fix broken tests for non-Fortran and CMake 3.21
  builds (TriBITSPub/TriBITS#363) component: core

* TriBITSPub/TriBITS#391: Fix up build_docs.sh for Sphinx doc generation
  (TriBITSPub/TriBITS#386) component: documentation type: enhancement

* TriBITSPub/TriBITS#390: Add test for doc generation and fix usage of Python3
  component: documentation type: bug

* TriBITSPub/TriBITS#385: Replace last few references to
  TribitsDevelopersGuide.html (TriBITSPub/TriBITS#381) component:
  documentation type: enhancement

* TriBITSPub/TriBITS#384: Split TribitsDevelopersGuide.* into
  TribitsUsersGuide.* and TribitsMaintainersGuide.* (TriBITSPub/TriBITS#381)
  component: documentation type: enhancement

* TriBITSPub/TriBITS#383: Remove endfunction(<string>) and endmacro(<string>)
  (TriBITSPub/TriBITS#274, TriBITSPub/TriBITS#382) component: common_tpls
  type: bug

* TriBITSPub/TriBITS#380: More package-arch data-structure documentation
  updates (TriBITSPub/TriBITS#63) component: documentation type: enhancement

* TriBITSPub/TriBITS#379: Convert TriBITS to lower-case CMake command, macro,
  and function names (TriBITSPub/TriBITS#274)

The following files were conflicting where I went with what is on the Trilinos
'develop' branch:

* cmake/tribits/common_tpls/FindTPLBLAS.cmake
* cmake/tribits/common_tpls/FindTPLLAPACK.cmake
* cmake/tribits/common_tpls/FindTPLNetcdf.cmake

(It looks like the above changes never made it back into TriBITS proper.  The
conflicts were due to the case changes in cmake command calls in these files
due to TriBITSPub/TriBITS#379.)

There was also a conflict in the file:

* cmake/tribits/core/installation/TribitsProjectConfigTemplate.cmake.in

I looked at that one carefully and I think that may have been due to fixes on
both sides and then the case changes from TriBITSPub/TriBITS#379.
@bartlettroscoe bartlettroscoe mentioned this issue Sep 4, 2021
Merged
@bartlettroscoe
Copy link
Member Author

This has been done for a long time with the merge of PR #384. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component: documentation type: enhancement
Projects
TriBITS Refactor
Status: Done
TriBITS Refactor
Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bartlettroscoe