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

Change log level for non-found files during PDF indexing #9678

Merged
merged 5 commits into from
Mar 18, 2023

Conversation

koppor
Copy link
Member

@koppor koppor commented Mar 17, 2023

The PDF indexer writes all non-found files in the log.

Example:

2023-03-17 11:45:05 [pool-1-thread-3] org.jabref.logic.pdf.search.indexing.PdfIndexer.writeToIndex()
WARN: Could not find C:/Users/Oliver/Documents/Arbeiten/DAs/3 - finished/2012 - Splitting BPEL/DIP 3255 - Splitting BPEL Processes - comments OK.pdf

It further outputs the index path:

INFO: Index path for C:\TEMP\cd\test-cd.bib is C:\Users\koppor\AppData\Local\org.jabref\JabRef\lucene94

This is IMHO too much noise. It is required for debugging.

I think, the reason was that log.txt never contained DEBUG lines. This is fixed in this PR.

One can enable debug using tinylog.properties as follows:

level@org.jabref.logic.autosaveandbackup.BackupManager = debug

See https://devdocs.jabref.org/code-howtos/logging.html for details. That howto was not that good, so this PR also refines that howto @calixtus .

  • Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@koppor koppor added status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers type: code-quality Issues related to code or architecture decisions labels Mar 17, 2023
calixtus
calixtus previously approved these changes Mar 17, 2023
@Siedlerchr Siedlerchr merged commit df7326d into main Mar 18, 2023
@Siedlerchr Siedlerchr deleted the reduce-log-noise branch March 18, 2023 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers type: code-quality Issues related to code or architecture decisions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants