Skip to content

Fix unsafe comment - #44

Merged
darincomeau merged 1 commit into
mainfrom
fix-unsafe-comment
Jul 23, 2026
Merged

Fix unsafe comment#44
darincomeau merged 1 commit into
mainfrom
fix-unsafe-comment

Conversation

@darincomeau

@darincomeau darincomeau commented Jul 23, 2026

Copy link
Copy Markdown
Member

Bringing comment change introduced in E3SM-Project/E3SM#8532 into main. Will subsequently update Icepack hash in E3SM-Project to point to main.

This change has already been brought in to CICE-Consortium/Icepack CICE-Consortium#562, noting for future sync of E3SM's Icepack.

Having a comment that ends in \ is not portable across different build systems due to the order and manner in which preprocessing is done. In some cases, like when using ninja, the \ can be interpreted as a line continuation which can silently remove the following line of code.

For detailed information about submitting Pull Requests (PRs) to the CICE-Consortium,
please refer to: https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index#information-for-developers

PR checklist

  • Short (1 sentence) summary of your PR:
    ENTER INFORMATION HERE
  • Developer(s):
    ENTER INFORMATION HERE
  • Suggest PR reviewers from list in the column to the right.
  • Please copy the PR test results link or provide a summary of testing completed below.
    ENTER INFORMATION HERE
  • How much do the PR code changes differ from the unmodified code?
    • [ X] bit for bit
    • different at roundoff level
    • more substantial
  • Does this PR create or have dependencies on CICE or any other models?
    • Yes
    • [ X] No
  • Does this PR add any new test cases?
    • Yes
    • [ X] No
  • Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.)
    • Yes
    • [ X] No, does the documentation need to be updated at a later time?
      • Yes
      • [ X] No
  • Please document the changes in detail, including why the changes are made. This will become part of the PR commit log.

Having a comment that ends in \ is not portable across different build systems
due to the order and manner in which preprocessing is done. In some cases,
like when using ninja, the \ can be interpreted as a line continuation which
can silently remove the following line of code.

@njeffery njeffery left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved based on inspection.

@darincomeau
darincomeau merged commit 319653f into main Jul 23, 2026
1 check passed
jonbob added a commit to E3SM-Project/E3SM that referenced this pull request Jul 24, 2026
…t (PR #8582)

Updating Icepack hash to main branch

Updates Icepack submodule hash to point to main. The comment change
introduced in #8532 changed the Icepack hash
(E3SM-Project/Icepack@5d30e92) away from main. This change has been
brought into the Icepack main branch in E3SM-Project/Icepack#44, so this
PR has no code changes, only submodule hash update.

[BFB]
jonbob added a commit to E3SM-Project/E3SM that referenced this pull request Jul 27, 2026
Updating Icepack hash to main branch

Updates Icepack submodule hash to point to main. The comment change
introduced in #8532 changed the Icepack hash
(E3SM-Project/Icepack@5d30e92) away from main. This change has been
brought into the Icepack main branch in E3SM-Project/Icepack#44, so this
PR has no code changes, only submodule hash update.

[BFB]
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.

3 participants