llnl / llnl/scr

Provide way for users to silence warning about detecting changed files

Open
#228 0 comments 0 reactions 1 assignee View on GitHub

@adammoody is already working on this.

Since Aug 12, 2020.

Dominant language
C
Stars
108
Forks
37
PR merge metrics
No merged PRs in 30d

Description

SCR now checks mtime, uid, gid, and mode bits when deleting a file from cache, comparing those to the values it recorded for the file when the application called complete_output. If there is a change, SCR prints a warning for each file.

The point of this is to help the user detect buggy usage of the SCR API, since SCR does not capture any changes to a file after the application has called complete_checkpoint. It likely means the application called complete_output too soon.

However, there might be cases where the user needs to modify files in someway and doesn't care that SCR will miss those particular changes. In this case, the user will get lots of annoying warnings printed. We need a way to shut those off.

Some ideas:

  • add a parameter to explicitly enable and report debug checks like this (leaning toward this option)
  • add a parameter to explicitly disable those check-on-delete warnings
  • only print the warnings when using SCR_DEBUG=1 or higher (this by itself is likely not sufficient, since the user may want SCR_DEBUG output and still want to silence those particular warnings)

None of these are difficult to add. Just creating the issue so I don't forget that we need to do it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.