docs.phext.io
LATEST REFERENCE
Reference as of head commit 0628c00360a22aafcaf4d0bf26a4991f9d29b900 · 3888 commits audited · chain sha256 41202a43a6a9c8d6…

phcc — project documentation

Scanned by phdoc 0.1.0 on 2026-11-22 (Exocortical Epoch 95). Project root: /home/wbic16/phdoc-sweep/proj/phcc/. Scanned at commit 0628c00360a22aafcaf4d0bf26a4991f9d29b900. Every fact in this document was read from its own records: its manifests, its git log, and its source text. Nothing here was guessed.

This document holds: what the project depends on, who wrote it, how large and how complex it is, the state of its quality signals, the RFCs it declares, where its upstream repo lives, and a plain English note for every public method and command.


Dependencies

No dependency manifest was found (no Cargo.toml, package.json, requirements.txt, or go.mod), so no dependencies are declared in a form the scanner reads.


Authors

The git log holds 3888 commits.

The author of record is Will Bickford — 99 commits folded into his account. Will's ruling (2026-11-22): all Exocortical authors fold into his account — "I speak for the cluster." The fold is presentation only: the git history is unchanged, and the per-persona detail is kept as annotation.

Annotation, by persona (all folded into Will Bickford):

Other authors, kept as themselves (not Exocortical cluster personas; never folded):


Complexity

The measure is stated plainly, and no single score is made: lines are counted per file as total lines, blank lines, comment lines, and code lines (total minus blank minus comment). Functions are counted where the scanner reads them, and the largest functions are given by their span in lines.

All languages: 699 files, 163895 lines total, 108568 lines of code. Functions read: 169.

Largest files:

Largest functions, by span in lines:


Code quality signals

Each signal is named and shown with its evidence. A signal is a fact the scanner read, not a grade.


Declared RFCs

No rfcs.json was found in this project, so it declares no RFCs. This is a finding, not an error: the project has not made an RFC declaration.


Upstream git repo


Public methods and commands

Every public method and command the scanner found, each with a plain English note. A note says where its words came from: the code's own doc comment, the item's signature, the user's agent, or it is marked awaiting a summary.


function — check

Found in examples/verify_examples.sh at line 27.

Signature: check()

What it does: Function check takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — sha

Found in tools/acceptance_local.py at line 21.

Signature: def sha(b):

What it does: Function sha takes b and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/acceptance_local.py at line 25.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — sha

Found in tools/assemble_reissue.py at line 21.

Signature: def sha(b):

What it does: Function sha takes b and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/assemble_reissue.py at line 25.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — sha

Found in tools/build_reissue.py at line 60.

Signature: def sha(b):

What it does: Function sha takes b and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — splice_block

Found in tools/build_reissue.py at line 64.

Signature: def splice_block(lines, path, new_lines):

What it does: Function splice_block takes lines, path, new_lines and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — normalize_listing

Found in tools/build_reissue.py at line 71.

Signature: def normalize_listing(body, objname):

What it does: Function normalize_listing takes body, objname and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — assembly_scroll

Found in tools/build_reissue.py at line 82.

Signature: def assembly_scroll(artifact, src_coord, src_sha, target, compiler, cmd,

What it does: Function assembly_scroll takes artifact, src_coord, src_sha, target, compiler, cmd, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — canonical

Found in tools/build_reissue.py at line 113.

Signature: def canonical(raw):

What it does: Function canonical takes raw and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/build_reissue.py at line 117.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — rd

Found in tools/build_reissue.py at line 195.

Signature: def rd(n):

What it does: Function rd takes n and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — old_body

Found in tools/build_reissue.py at line 247.

Signature: def old_body(coord):

What it does: Function old_body takes coord and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — parse_machine

Found in tools/check_linker.py at line 118.

Signature: def parse_machine(text):

What it does: Function parse_machine takes text and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — vol3_members

Found in tools/check_linker.py at line 162.

Signature: def vol3_members(scrolls, index_coord, kind):

What it does: Function vol3_members takes scrolls, index_coord, kind and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — struct_fields

Found in tools/check_linker.py at line 172.

Signature: def struct_fields(text, struct_name):

What it does: Function struct_fields takes text, struct_name and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — defines

Found in tools/check_linker.py at line 210.

Signature: def defines(text):

What it does: Function defines takes text and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/check_linker.py at line 214.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — parse_machine

Found in tools/check_machine.py at line 52.

Signature: def parse_machine(text):

What it does: Split the scroll into sections; return dict of parsed parts.

(Where these words came from: doc comment.)


function — vol3_functions

Found in tools/check_machine.py at line 98.

Signature: def vol3_functions(scrolls, index_coord):

What it does: Function vol3_functions takes scrolls, index_coord and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — vol3_objects

Found in tools/check_machine.py at line 108.

Signature: def vol3_objects(scrolls, index_coord):

What it does: Function vol3_objects takes scrolls, index_coord and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — struct_fields

Found in tools/check_machine.py at line 118.

Signature: def struct_fields(text, struct_name):

What it does: Extract field identifiers from a struct body in C source.

(Where these words came from: doc comment.)


function — defines

Found in tools/check_machine.py at line 166.

Signature: def defines(text):

What it does: Function defines takes text and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/check_machine.py at line 170.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — parse_machine

Found in tools/check_regalloc.py at line 153.

Signature: def parse_machine(text):

What it does: Function parse_machine takes text and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — vol3_members

Found in tools/check_regalloc.py at line 198.

Signature: def vol3_members(scrolls, index_coord, kind):

What it does: Function vol3_members takes scrolls, index_coord, kind and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — struct_fields

Found in tools/check_regalloc.py at line 208.

Signature: def struct_fields(text, struct_name):

What it does: Function struct_fields takes text, struct_name and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — defines

Found in tools/check_regalloc.py at line 247.

Signature: def defines(text):

What it does: Function defines takes text and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — check_one

Found in tools/check_regalloc.py at line 252.

Signature: def check_one(scrolls, mcoord, funcs, universe_base, label):

What it does: Function check_one takes scrolls, mcoord, funcs, universe_base, label and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/check_regalloc.py at line 320.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — parse_machine

Found in tools/check_vstack.py at line 118.

Signature: def parse_machine(text):

What it does: Split the scroll into sections; return dict of parsed parts.

(Where these words came from: doc comment.)


function — vol3_members

Found in tools/check_vstack.py at line 164.

Signature: def vol3_members(scrolls, index_coord, kind):

What it does: Function vol3_members takes scrolls, index_coord, kind and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — struct_fields

Found in tools/check_vstack.py at line 174.

Signature: def struct_fields(text, struct_name):

What it does: Extract field identifiers from a struct body in C source.

(Where these words came from: doc comment.)


function — defines

Found in tools/check_vstack.py at line 216.

Signature: def defines(text):

What it does: Function defines takes text and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/check_vstack.py at line 220.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — load_scrolls

Found in tools/phcc_analyze.py at line 75.

Signature: def load_scrolls(path):

What it does: Function load_scrolls takes path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — is_binary_scroll

Found in tools/phcc_analyze.py at line 79.

Signature: def is_binary_scroll(content):

What it does: Function is_binary_scroll takes content and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — collect_segments

Found in tools/phcc_analyze.py at line 85.

Signature: def collect_segments(scrolls, entries):

What it does: Segment records for every manifest file with a Volume 3 index,

(Where these words came from: doc comment.)


function — normalize_code

Found in tools/phcc_analyze.py at line 140.

Signature: def normalize_code(data):

What it does: C-comment-stripped, whitespace-collapsed form of a member

(Where these words came from: doc comment.)


function — census

Found in tools/phcc_analyze.py at line 180.

Signature: def census(scrolls, entries, segs):

What it does: All census groupings. Returns a dict of tallies + clusters.

(Where these words came from: doc comment.)


function — cluster_stats

Found in tools/phcc_analyze.py at line 253.

Signature: def cluster_stats(clusters, size_of):

What it does: Function cluster_stats takes clusters, size_of and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — first_line

Found in tools/phcc_analyze.py at line 259.

Signature: def first_line(content, limit=72):

What it does: Function first_line takes content, limit=72 and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — render_report

Found in tools/phcc_analyze.py at line 264.

Signature: def render_report(phext_path, raw, scrolls, entries, segs, problems,

What it does: Function render_report takes phext_path, raw, scrolls, entries, segs, problems, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — render_apply

Found in tools/phcc_analyze.py at line 384.

Signature: def render_apply(ai):

What it does: Function render_apply takes ai and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — apply_dedup

Found in tools/phcc_analyze.py at line 432.

Signature: def apply_dedup(scrolls, entries, segs, cz):

What it does: Rewrite exact duplicates as dedup stubs. Returns

(Where these words came from: doc comment.)


function — demote_scan

Found in tools/phcc_analyze.py at line 502.

Signature: def demote_scan(scrolls, changed, touched, rewritten, seg_stubs):

What it does: Find every binding a rewrite invalidates. A scroll (other

(Where these words came from: doc comment.)


function — split_segments

Found in tools/phcc_analyze.py at line 587.

Signature: def split_segments(data):

What it does: Split a C payload into statement-grain segments.

(Where these words came from: doc comment.)


function — cut

Found in tools/phcc_analyze.py at line 621.

Signature: def cut(end, term):

What it does: Function cut takes end, term and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — stmt_group

Found in tools/phcc_analyze.py at line 742.

Signature: def stmt_group(path):

What it does: Coarse grouping for per-backend ratios.

(Where these words came from: doc comment.)


function — statement_census

Found in tools/phcc_analyze.py at line 764.

Signature: def statement_census(segs):

What it does: Segment every segment payload and tally the statement

(Where these words came from: doc comment.)


function — bucket

Found in tools/phcc_analyze.py at line 788.

Signature: def bucket(ln):

What it does: Function bucket takes ln and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — render_stmt_report

Found in tools/phcc_analyze.py at line 870.

Signature: def render_stmt_report(phext_path, raw, segs, sc, build_info=None):

What it does: Function render_stmt_report takes phext_path, raw, segs, sc, build_info=None and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — render_stmt_build

Found in tools/phcc_analyze.py at line 967.

Signature: def render_stmt_build(bi):

What it does: Function render_stmt_build takes bi and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — assign_stmt_coords

Found in tools/phcc_analyze.py at line 997.

Signature: def assign_stmt_coords(cores):

What it does: Content-derived coordinates for the statement library.

(Where these words came from: doc comment.)


function — build_stmt

Found in tools/phcc_analyze.py at line 1045.

Signature: def build_stmt(scrolls, segs, sc, src_sha):

What it does: Rewrite every segment payload as a statement reference

(Where these words came from: doc comment.)


function — verify_stmt

Found in tools/phcc_analyze.py at line 1096.

Signature: def verify_stmt(scrolls, entries):

What it does: Verify a statement-level phext against its own records:

(Where these words came from: doc comment.)


function — run

Found in tools/phcc_analyze.py at line 1176.

Signature: def run(a):

What it does: Function run takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cli

Found in tools/phcc_analyze.py at line 1289.

Signature: def cli(argv):

What it does: Function cli takes argv and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — sha256

Found in tools/phcc_builds.py at line 53.

Signature: def sha256(b):

What it does: Function sha256 takes b and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — is_region

Found in tools/phcc_builds.py at line 57.

Signature: def is_region(coord):

What it does: Function is_region takes coord and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — is_canonical_binary_scroll

Found in tools/phcc_builds.py at line 61.

Signature: def is_canonical_binary_scroll(content):

What it does: Function is_canonical_binary_scroll takes content and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — encode_canonical_binary_scroll

Found in tools/phcc_builds.py at line 65.

Signature: def encode_canonical_binary_scroll(raw):

What it does: Function encode_canonical_binary_scroll takes raw and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — decode_canonical_binary_scroll

Found in tools/phcc_builds.py at line 69.

Signature: def decode_canonical_binary_scroll(content):

What it does: Raw bytes of a canonical binary scroll, or raise ValueError.

(Where these words came from: doc comment.)


function — parse_binary_scroll

Found in tools/phcc_builds.py at line 77.

Signature: def parse_binary_scroll(content):

What it does: (header dict, raw bytes) or raise ValueError.

(Where these words came from: doc comment.)


function — parse_region_manifest

Found in tools/phcc_builds.py at line 110.

Signature: def parse_region_manifest(content):

What it does: {coord-string: entry dict} from the region root manifest.

(Where these words came from: doc comment.)


function — cmd_region_list

Found in tools/phcc_builds.py at line 128.

Signature: def cmd_region_list(a):

What it does: Function cmd_region_list takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmd_region_wipe

Found in tools/phcc_builds.py at line 170.

Signature: def cmd_region_wipe(a):

What it does: Function cmd_region_wipe takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmd_seal

Found in tools/phcc_builds.py at line 184.

Signature: def cmd_seal(a):

What it does: Function cmd_seal takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmd_unseal

Found in tools/phcc_builds.py at line 201.

Signature: def cmd_unseal(a):

What it does: Function cmd_unseal takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cli

Found in tools/phcc_builds.py at line 215.

Signature: def cli(argv):

What it does: Function cli takes argv and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — analyse

Found in tools/phcc_gate.py at line 99.

Signature: def analyse(scrolls):

What it does: Function analyse takes scrolls and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — pct

Found in tools/phcc_gate.py at line 137.

Signature: def pct(n, d):

What it does: Function pct takes n, d and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — tables_text

Found in tools/phcc_gate.py at line 141.

Signature: def tables_text(per_book, artifacts, gaps, t1_eligible,

What it does: Function tables_text takes per_book, artifacts, gaps, t1_eligible, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — verdict_text

Found in tools/phcc_gate.py at line 215.

Signature: def verdict_text(scrolls, artifacts, per_book, gaps, t1_eligible,

What it does: Function verdict_text takes scrolls, artifacts, per_book, gaps, t1_eligible, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — parse_proof_claims

Found in tools/phcc_gate.py at line 267.

Signature: def parse_proof_claims(scrolls):

What it does: Return {source_coord: claim-dict} for artifacts with Proofs scrolls.

(Where these words came from: doc comment.)


function — tiers_from_receipts

Found in tools/phcc_gate.py at line 289.

Signature: def tiers_from_receipts(claims):

What it does: {source_coord: (tier, note)} — the receipted tier overlay.

(Where these words came from: doc comment.)


function — parse_design_views

Found in tools/phcc_gate.py at line 352.

Signature: def parse_design_views(scrolls):

What it does: Return {'checked': n, 'current': [path], 'stale': [(path,

(Where these words came from: doc comment.)


function — machine_section

Found in tools/phcc_gate.py at line 410.

Signature: def machine_section(scrolls, phext_path):

What it does: Function machine_section takes scrolls, phext_path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — machine2_section

Found in tools/phcc_gate.py at line 483.

Signature: def machine2_section(scrolls, phext_path):

What it does: Function machine2_section takes scrolls, phext_path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — machine3_section

Found in tools/phcc_gate.py at line 564.

Signature: def machine3_section(scrolls, phext_path):

What it does: Function machine3_section takes scrolls, phext_path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — machine4_section

Found in tools/phcc_gate.py at line 641.

Signature: def machine4_section(scrolls, phext_path):

What it does: Function machine4_section takes scrolls, phext_path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — decode_binary_scroll

Found in tools/phcc_gate.py at line 748.

Signature: def decode_binary_scroll(content):

What it does: Raw bytes of a binary scroll, or None if undecodable.

(Where these words came from: doc comment.)


function — assembly_section

Found in tools/phcc_gate.py at line 774.

Signature: def assembly_section(scrolls):

What it does: Function assembly_section takes scrolls and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — conformance_section

Found in tools/phcc_gate.py at line 885.

Signature: def conformance_section(scrolls):

What it does: Function conformance_section takes scrolls and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/phcc_gate.py at line 1064.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — nm_symbols

Found in tools/phcc_harvest.py at line 20.

Signature: def nm_symbols(path):

What it does: Return {object_name: (defined_global, defined_local, undefined)}.

(Where these words came from: doc comment.)


function — main

Found in tools/phcc_harvest.py at line 52.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — load_scrolls

Found in tools/phcc_migrate.py at line 78.

Signature: def load_scrolls(path):

What it does: Function load_scrolls takes path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — manifest_entries

Found in tools/phcc_migrate.py at line 82.

Signature: def manifest_entries(scrolls):

What it does: Function manifest_entries takes scrolls and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — write_file

Found in tools/phcc_migrate.py at line 96.

Signature: def write_file(out, path, data, mode):

What it does: Function write_file takes out, path, data, mode and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — resolve_stub

Found in tools/phcc_migrate.py at line 107.

Signature: def resolve_stub(scrolls, data, segment, stats):

What it does: Expand a dedup stub (phext_io dedup refs, written by

(Where these words came from: doc comment.)


function — resolve_stmt_seq

Found in tools/phcc_migrate.py at line 147.

Signature: def resolve_stmt_seq(scrolls, data, stats=None):

What it does: Expand a statement reference sequence (phext_io statement

(Where these words came from: doc comment.)


function — unpack_vol2

Found in tools/phcc_migrate.py at line 185.

Signature: def unpack_vol2(scrolls, entries, stats=None):

What it does: Yield (path, data, mode, ok, why).

(Where these words came from: doc comment.)


function — unpack_vol3

Found in tools/phcc_migrate.py at line 208.

Signature: def unpack_vol3(scrolls, entries, stats=None):

What it does: Reassemble from Volume 3 segment scrolls where a file index

(Where these words came from: doc comment.)


function — cmd_export

Found in tools/phcc_migrate.py at line 286.

Signature: def cmd_export(a):

What it does: Function cmd_export takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — place

Found in tools/phcc_migrate.py at line 335.

Signature: def place(path):

What it does: Return (book, chapter) for a repo-relative path, or None.

(Where these words came from: doc comment.)


function — place_full

Found in tools/phcc_migrate.py at line 387.

Signature: def place_full(path):

What it does: Return (collection, volume, book, chapter) for a path, or None.

(Where these words came from: doc comment.)


function — phext_dir_exclusion

Found in tools/phcc_migrate.py at line 418.

Signature: def phext_dir_exclusion(path):

What it does: Why a phext/** path is excluded from pack placement (the

(Where these words came from: doc comment.)


function — enumerate_tree

Found in tools/phcc_migrate.py at line 499.

Signature: def enumerate_tree(tree):

What it does: [(mode, path)] for every packable file under tree, path-sorted.

(Where these words came from: doc comment.)


function — stage_a

Found in tools/phcc_migrate.py at line 528.

Signature: def stage_a(tree, base_phext):

What it does: Build the Volume 1 + Volume 2 scroll set. Returns dict.

(Where these words came from: doc comment.)


function — find_tool

Found in tools/phcc_migrate.py at line 597.

Signature: def find_tool(name):

What it does: Function find_tool takes name and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — find_ts_python

Found in tools/phcc_migrate.py at line 609.

Signature: def find_ts_python(explicit):

What it does: Function find_ts_python takes explicit and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmd_import

Found in tools/phcc_migrate.py at line 627.

Signature: def cmd_import(a):

What it does: Function cmd_import takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cli

Found in tools/phcc_migrate.py at line 668.

Signature: def cli(argv):

What it does: Function cli takes argv and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — __init__

Found in tools/phcc_prune.py at line 156.

Signature: def __init__(self, path, scr, kind, names, form, span, psha, payload,

What it does: Function __init__ takes self, path, scr, kind, names, form, span, psha, payload, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — mid

Found in tools/phcc_prune.py at line 163.

Signature: def mid(self):

What it does: Function mid takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — __init__

Found in tools/phcc_prune.py at line 171.

Signature: def __init__(self, entry):

What it does: Function __init__ takes self, entry and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — load_carried

Found in tools/phcc_prune.py at line 181.

Signature: def load_carried(phext_path):

What it does: Return (scrolls, [CarriedFile]) — main manifest + Sec-14 addendum.

(Where these words came from: doc comment.)


function — __init__

Found in tools/phcc_prune.py at line 241.

Signature: def __init__(self, path):

What it does: Function __init__ takes self, path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — include_closure

Found in tools/phcc_prune.py at line 300.

Signature: def include_closure(files_by_path, seeds, build_prereqs=frozenset()):

What it does: #include closure over carried files, starting at seeds.

(Where these words came from: doc comment.)


function — resolve

Found in tools/phcc_prune.py at line 320.

Signature: def resolve(p, name):

What it does: Function resolve takes p, name and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — is_build_ref_file

Found in tools/phcc_prune.py at line 358.

Signature: def is_build_ref_file(path):

What it does: Files whose text the build itself reads as instructions —

(Where these words came from: doc comment.)


function — classify_files

Found in tools/phcc_prune.py at line 366.

Signature: def classify_files(files, graph_files, extra_keep,

What it does: Function classify_files takes files, graph_files, extra_keep, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — build_graph

Found in tools/phcc_prune.py at line 429.

Signature: def build_graph(files, classes):

What it does: Members of graph-class files; name index; raw payload store.

(Where these words came from: doc comment.)


function — build_suffix_index

Found in tools/phcc_prune.py at line 460.

Signature: def build_suffix_index(name2members):

What it does: name-suffix -> [member ids]: for every member name, every

(Where these words came from: doc comment.)


function — member_edges

Found in tools/phcc_prune.py at line 475.

Signature: def member_edges(m, name2members, toks, providers, suffix_index):

What it does: Out-edges of one member: every member bearing a name tokenised

(Where these words came from: doc comment.)


function — build_providers

Found in tools/phcc_prune.py at line 504.

Signature: def build_providers(members, name2members, toks):

What it does: token -> [member ids] for referenced tokens no member is

(Where these words came from: doc comment.)


function — prune

Found in tools/phcc_prune.py at line 526.

Signature: def prune(phext_path, harvest_path, extra_roots, extra_keep,

What it does: Function prune takes phext_path, harvest_path, extra_roots, extra_keep, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — add_root

Found in tools/phcc_prune.py at line 594.

Signature: def add_root(mid, why):

What it does: Function add_root takes mid, why and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — emit

Found in tools/phcc_prune.py at line 730.

Signature: def emit(res, phext_path):

What it does: Function emit takes res, phext_path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — prune_manifest_text

Found in tools/phcc_prune.py at line 822.

Signature: def prune_manifest_text(res, stats):

What it does: Function prune_manifest_text takes res, stats and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cli

Found in tools/phcc_prune.py at line 873.

Signature: def cli(argv):

What it does: Function cli takes argv and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — source_bytes

Found in tools/phcc_prune.py at line 922.

Signature: def source_bytes(scrolls):

What it does: Function source_bytes takes scrolls and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — fmt

Found in tools/phext_io.py at line 18.

Signature: def fmt(coord):

What it does: Function fmt takes coord and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — parse_coord

Found in tools/phext_io.py at line 22.

Signature: def parse_coord(s):

What it does: Function parse_coord takes s and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — walk_bytes

Found in tools/phext_io.py at line 30.

Signature: def walk_bytes(data):

What it does: Dead-reckoning byte walk — same state machine as parse_phext.py,

(Where these words came from: doc comment.)


function — implode

Found in tools/phext_io.py at line 52.

Signature: def implode(scrolls):

What it does: scrolls: dict coord_tuple -> bytes. Same emitter as Slice 0.

(Where these words came from: doc comment.)


function — sha256

Found in tools/phext_io.py at line 68.

Signature: def sha256(data):

What it does: Function sha256 takes data and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — load_phext

Found in tools/phext_io.py at line 72.

Signature: def load_phext(path):

What it does: Function load_phext takes path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — dedup_ref

Found in tools/phext_io.py at line 99.

Signature: def dedup_ref(coord, payload_sha256):

What it does: The stub bytes standing for the payload at coord.

(Where these words came from: doc comment.)


function — parse_dedup_ref

Found in tools/phext_io.py at line 105.

Signature: def parse_dedup_ref(data):

What it does: (coord_tuple, sha256_hex) if data is exactly a dedup stub,

(Where these words came from: doc comment.)


function — stmt_ref

Found in tools/phext_io.py at line 149.

Signature: def stmt_ref(coord, core_sha256, indent):

What it does: One reference line (bytes, newline-terminated).

(Where these words came from: doc comment.)


function — stmt_ref_empty

Found in tools/phext_io.py at line 156.

Signature: def stmt_ref_empty(indent):

What it does: The reference line for a whitespace-only segment.

(Where these words came from: doc comment.)


function — parse_stmt_seq

Found in tools/phext_io.py at line 162.

Signature: def parse_stmt_seq(data):

What it does: Parse a statement reference sequence payload. Returns a list

(Where these words came from: doc comment.)


function — parse_manifest

Found in tools/phext_io.py at line 200.

Signature: def parse_manifest(scrolls):

What it does: Return {path: coord_tuple} from the Slice 0 placement manifest

(Where these words came from: doc comment.)


function — segment_one

Found in tools/segment_libtcc1.py at line 33.

Signature: def segment_one(path, data, v2coord_s):

What it does: Function segment_one takes path, data, v2coord_s and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/segment_libtcc1.py at line 145.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — check

Found in tools/test_analyze.py at line 38.

Signature: def check(cond, label):

What it does: Function check takes cond, label and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — run

Found in tools/test_analyze.py at line 44.

Signature: def run(args, cwd):

What it does: Function run takes args, cwd and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — file_bytes

Found in tools/test_analyze.py at line 89.

Signature: def file_bytes(path):

What it does: Function file_bytes takes path and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — build_fixture

Found in tools/test_analyze.py at line 96.

Signature: def build_fixture(corrupt_index=False):

What it does: Function build_fixture takes corrupt_index=False and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — read_tree

Found in tools/test_analyze.py at line 149.

Signature: def read_tree(d):

What it does: Function read_tree takes d and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/test_analyze.py at line 153.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — check

Found in tools/test_prune.py at line 32.

Signature: def check(cond, label):

What it does: Function check takes cond, label and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — seg_header

Found in tools/test_prune.py at line 38.

Signature: def seg_header(kind, name, form, span, psha):

What it does: Function seg_header takes kind, name, form, span, psha and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — structured_file

Found in tools/test_prune.py at line 43.

Signature: def structured_file(path, coord, rows):

What it does: rows: [(kind, name, form, payload)] -> (vol2 bytes, scrolls dict)

(Where these words came from: doc comment.)


function — build_fixture

Found in tools/test_prune.py at line 183.

Signature: def build_fixture(td):

What it does: Function build_fixture takes td and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/test_prune.py at line 211.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — check

Found in tools/test_stmt.py at line 26.

Signature: def check(name, cond, detail=""):

What it does: Function check takes name, cond, detail="" and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cores

Found in tools/test_stmt.py at line 35.

Signature: def cores(data):

What it does: Function cores takes data and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — seg_scroll

Found in tools/test_stmt.py at line 151.

Signature: def seg_scroll(kind, name, form, span, payload):

What it does: Function seg_scroll takes kind, name, form, span, payload and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — fmt

Found in tools/upstream_carry.py at line 81.

Signature: def fmt(coord):

What it does: Function fmt takes coord and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — parse_coord

Found in tools/upstream_carry.py at line 85.

Signature: def parse_coord(s):

What it does: Function parse_coord takes s and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — walk_bytes

Found in tools/upstream_carry.py at line 93.

Signature: def walk_bytes(data):

What it does: Dead-reckoning byte walk — yields (coord_tuple, bytes) so

(Where these words came from: doc comment.)


function — implode

Found in tools/upstream_carry.py at line 112.

Signature: def implode(scrolls):

What it does: scrolls: dict coord_tuple -> bytes. The lineage emitter.

(Where these words came from: doc comment.)


function — sha256

Found in tools/upstream_carry.py at line 128.

Signature: def sha256(data):

What it does: Function sha256 takes data and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — encode_scroll

Found in tools/upstream_carry.py at line 132.

Signature: def encode_scroll(data):

What it does: Return (scroll_bytes, encoding) for one file's bytes.

(Where these words came from: doc comment.)


function — decode_scroll

Found in tools/upstream_carry.py at line 150.

Signature: def decode_scroll(scroll, encoding):

What it does: Function decode_scroll takes scroll, encoding and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — git

Found in tools/upstream_carry.py at line 196.

Signature: def git(repo, *args):

What it does: Function git takes repo, *args and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — placement

Found in tools/upstream_carry.py at line 201.

Signature: def placement(entries):

What it does: entries: list of paths (files only). Returns {path: coord}.

(Where these words came from: doc comment.)


function — cmd_build

Found in tools/upstream_carry.py at line 229.

Signature: def cmd_build(a):

What it does: Function cmd_build takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmd_unpack

Found in tools/upstream_carry.py at line 335.

Signature: def cmd_unpack(a):

What it does: Function cmd_unpack takes a and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — main

Found in tools/upstream_carry.py at line 365.

Signature: def main():

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — func

Found in tools/verify_gate_splice_81.py at line 23.

Signature: def func(text, name):

What it does: Function func takes text, name and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


Provenance

This documentation is produced for the export repo wbic16/phdoc (its chain of record lives at docs/phcc/chain.phext) and for the doc site https://docs.phext.io. Both targets are the project's own configuration, held in its .phdoc.json as "export-repo" and "doc-site"; when a project does not name them, the defaults are wbic16/phdoc and https://docs.phext.io.

Historical reference · chain.phext · latest.md