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

File Header Section Cleanup #720

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

scrasmussen
Copy link
Member

TYPE: no impact

KEYWORDS: cleanup

SOURCE: Soren Rasmussen, NCAR

DESCRIPTION OF CHANGES: Cleanup of the file header section since it is not used. Example of bash script used to automate process:

sstring="!  Program Name:
!  Author(s)/Contact(s):
!  Abstract:
!  History Log:
!  <brief list of changes to this source file>
!
!  Usage:
!  Parameters: <Specify typical arguments passed>
!  Input Files:
!        <list file names and briefly describe the data they include>
!  Output Files:
!        <list file names and briefly describe the information they include>
!
!  Condition codes:
!        <list exit condition or error codes returned >
!        If appropriate, descriptive troubleshooting instructions or
!        likely causes for failures could be mentioned here with the
!        appropriate error code
!
!  User controllable options: <if applicable>"

for f in "${filelist[@]}"; do
    hstring=$(head -n 20 "$f")
    if [ "$hstring" = "$sstring" ]; then
        tail -n +21 "$f" > temp_file
        mv temp_file "$f"
    fi
done

TESTS CONDUCTED: Not needed

NOTES: may not be an important change but it makes for easy programming during a late night bad horror movie 👻

Checklist

  • Closes issue #xxxx (An issue must exist or be created to be closed. The issue describes and documents the problem and general solution, the PR describes the technical details of the solution.)
  • Tests added (unit tests and/or regression/integration tests)
  • Backwards compatible
  • Requires new files? If so, how to generate them.
  • Documentation included
  • Short description in the Development section of NEWS.md

@scrasmussen scrasmussen force-pushed the no-impact/file-header-cleanup branch 2 times, most recently from 1e6f8ba to 95c7169 Compare October 17, 2023 22:29
@scrasmussen scrasmussen force-pushed the no-impact/file-header-cleanup branch from 95c7169 to 981f483 Compare June 5, 2024 16:05
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.

None yet

1 participant