docs(host): three texts still describe a %TEMP% or multi-destination fallback the bootstrap diagnostics no longer have

Open Beginner friendly
  • Is something wrong?
#2,124 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
cpp, python
Domain
documentation

Research direction

Read src/runtime/host/bootstrap_diagnostics.h and docs/standards/logging.md Rule 17, then check the three passages named in the issue against the cited implementation comments. Update them to describe the single main log destination and standard-error fallback for dropped records. Run python3 tools/verify_doc_paths.py and python3 tools/check_known_wrong.py --online; done when both pass and all three passages match the documented behavior.

Written by the indexing model from the issue text.

Description

backlog documentation

Evidence at 2ce94a74

The host's bootstrap diagnostics write to one destination, the main log: DiagnosticDestination has only kPrimary and kDropped (src/runtime/host/bootstrap_diagnostics.h), and a record the main log refuses goes to standard error. Three texts still describe a fallback to %TEMP% or to several destinations:

  • docs/adr/0008-bugsplat-host-and-nevr-runtime.md:150-153: "a record whose write fails after its wait falls back to the next of up to three destinations and waits again, so a crash of up to four records can wait more than four times".
  • src/runtime/host/bootstrap_diagnostics.cpp:651-652: "a record that fell back to %TEMP% does not name the primary directory".
  • docs/standards/logging.md:169 (the log field of the NEVR.STOP table): "the %TEMP% copy when the primary folder refused it".

They contradict docs/standards/logging.md Rule 17 ("never ... %TEMP%") and the header comments of bootstrap_diagnostics.h and host_paths.h, which say there is no %TEMP% folder.

Not shown

Whether any reader or test depends on the old wording. git grep for the three quoted phrases over src, tools and docs finds only these places.

Falsifier

An AppendTo call on any directory other than primary_dir_, or any record in a run log carrying a log path under %TEMP%. Either would mean the one-destination reading is wrong and the texts are right.

Work

  1. Rewrite each of the three passages to describe the one destination and the standard-error fallback for a dropped record.
  2. Run python3 tools/verify_doc_paths.py and python3 tools/check_known_wrong.py --online on the result.

꩜🌸

Dominant language
C++
Stars
2
Forks
5
Avg merge
4h 46m
Merged PRs (30d)
941

Getting set up

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.

More from EchoTools/nevr-runtime

All issues in EchoTools/nevr-runtime

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.