README: document the repository layout and every script - #1
Open
shakeelb wants to merge 1 commit into
Open
Conversation
Top-level README covering all 412 tracked files: the shared sh/ library stack, the rcli command trees (vm, fstests-utils, fsperf-utils and the rest), the bug reproducers, and the bt/ c/ drgn/ fio/ frag/ py/ rust/ tool directories. Section 1 declares the table convention and the technical vocabulary. Signed-off-by: Shakeel Butt <shakeel.butt@linux.dev> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a top-level
README.md. New file only — no existing file is touched,and there is no functional change.
What it covers
Every one of the 412 tracked files gets a one-line description, grouped by
directory:
bt/(52) — bpftrace, split into allocator / locks / flush pipeline / IOc/(19),drgn/(14),fio/,frag/,py/,rust/2. the
rclicommand trees, and therun/usage/help/Makefilecontractthey all follow
3. the bug reproducers, including the recurring
standalone-minimal.sh/*-minimal.sh/parallel-test.shconvention4. the experiment and workload scripts
It also documents the
make install→~/.rcli/clis/<name>/symlink flow, andcarries a warning that nearly every
sh/script runsmkfson the device itis handed.
The existing docs (
sh/fstests-utils/INFRA.mdand the four per-bug READMEs)are pointed at, not duplicated or replaced.