Gecko [ theprintave.ca ]

Name	Size	Permission	Date
atomic	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
basic	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
clang-tools	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
coccinelle	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
dtc	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
dummy-tools	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
gcc-plugins	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
gdb	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
genksyms	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
kconfig	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
ksymoops	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
mod	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
package	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
selinux	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
tracing	[ DIR ]	drwxr-xr-x	2025-05-06 06:30
.gitignore	214 B	-rw-r--r--	2024-03-10 20:38
Kbuild.include	10.1 KB	-rw-r--r--	2024-03-10 20:38
Kconfig.include	2.65 KB	-rw-r--r--	2025-04-15 13:08
Lindent	502 B	-rwxr-xr-x	2024-03-10 20:38
Makefile	1.87 KB	-rw-r--r--	2024-03-10 20:38
Makefile.asm-generic	1.82 KB	-rw-r--r--	2024-03-10 20:38
Makefile.btf	638 B	-rw-r--r--	2024-03-10 20:38
Makefile.build	17.2 KB	-rw-r--r--	2025-04-15 13:08
Makefile.clang	1.61 KB	-rw-r--r--	2024-03-10 20:38
Makefile.clean	1.87 KB	-rw-r--r--	2024-03-10 20:38
Makefile.compiler	2.74 KB	-rw-r--r--	2024-03-10 20:38
Makefile.debug	1.12 KB	-rw-r--r--	2024-03-10 20:38
Makefile.defconf	1.17 KB	-rw-r--r--	2024-03-10 20:38
Makefile.dtbinst	1.03 KB	-rw-r--r--	2025-04-15 13:08
Makefile.extrawarn	7.1 KB	-rw-r--r--	2025-04-15 13:08
Makefile.gcc-plugins	2.59 KB	-rw-r--r--	2024-03-10 20:38
Makefile.headersinst	2.88 KB	-rw-r--r--	2024-03-10 20:38
Makefile.host	5.91 KB	-rw-r--r--	2024-03-10 20:38
Makefile.kasan	2.45 KB	-rw-r--r--	2024-03-10 20:38
Makefile.kcov	333 B	-rw-r--r--	2024-03-10 20:38
Makefile.kcsan	1004 B	-rw-r--r--	2024-03-10 20:38
Makefile.kmsan	208 B	-rw-r--r--	2024-03-10 20:38
Makefile.lib	21.1 KB	-rw-r--r--	2025-04-15 13:08
Makefile.modfinal	2.63 KB	-rw-r--r--	2025-04-15 13:08
Makefile.modinst	4.02 KB	-rw-r--r--	2025-04-15 13:08
Makefile.modpost	4.69 KB	-rw-r--r--	2024-03-10 20:38
Makefile.package	8.73 KB	-rw-r--r--	2025-04-15 13:08
Makefile.randstruct	511 B	-rw-r--r--	2024-03-10 20:38
Makefile.ubsan	779 B	-rw-r--r--	2024-03-10 20:38
Makefile.userprogs	1.59 KB	-rw-r--r--	2024-03-10 20:38
Makefile.vdsoinst	1.15 KB	-rw-r--r--	2025-04-15 13:08
Makefile.vmlinux	1.48 KB	-rw-r--r--	2024-03-10 20:38
Makefile.vmlinux_o	3.27 KB	-rw-r--r--	2024-03-10 20:38
as-version.sh	2.03 KB	-rwxr-xr-x	2024-03-10 20:38
asn1_compiler.c	35.32 KB	-rw-r--r--	2024-03-10 20:38
bloat-o-meter	3.77 KB	-rwxr-xr-x	2024-03-10 20:38
bootgraph.pl	5.64 KB	-rwxr-xr-x	2024-03-10 20:38
bpf_doc.py	31.73 KB	-rwxr-xr-x	2025-04-15 13:08
cc-can-link.sh	166 B	-rwxr-xr-x	2024-03-10 20:38
cc-version.sh	1.36 KB	-rwxr-xr-x	2024-03-10 20:38
check-git	298 B	-rwxr-xr-x	2024-03-10 20:38
check-sysctl-docs	3.66 KB	-rwxr-xr-x	2024-03-10 20:38
check-uapi.sh	15.05 KB	-rwxr-xr-x	2024-03-10 20:38
check_extable.sh	4.93 KB	-rwxr-xr-x	2024-03-10 20:38
checkdeclares.pl	1.1 KB	-rwxr-xr-x	2024-03-10 20:38
checkincludes.pl	1.94 KB	-rwxr-xr-x	2024-03-10 20:38
checkkconfigsymbols.py	15.75 KB	-rwxr-xr-x	2024-03-10 20:38
checkpatch.pl	233.78 KB	-rwxr-xr-x	2025-04-15 13:08
checkstack.pl	5.96 KB	-rwxr-xr-x	2024-03-10 20:38
checksyscalls.sh	7.51 KB	-rwxr-xr-x	2024-03-10 20:38
checkversion.pl	2.16 KB	-rwxr-xr-x	2024-03-10 20:38
cleanfile	3.46 KB	-rwxr-xr-x	2024-03-10 20:38
cleanpatch	5.06 KB	-rwxr-xr-x	2024-03-10 20:38
coccicheck	7.9 KB	-rwxr-xr-x	2024-03-10 20:38
config	4.67 KB	-rwxr-xr-x	2024-03-10 20:38
const_structs.checkpatch	1.4 KB	-rw-r--r--	2024-03-10 20:38
decode_stacktrace.sh	7.58 KB	-rwxr-xr-x	2024-03-10 20:38
decodecode	4.86 KB	-rwxr-xr-x	2024-03-10 20:38
depmod.sh	697 B	-rwxr-xr-x	2024-03-10 20:38
dev-needs.sh	6.07 KB	-rwxr-xr-x	2024-03-10 20:38
diffconfig	4.12 KB	-rwxr-xr-x	2024-03-10 20:38
documentation-file-ref-check	5.67 KB	-rwxr-xr-x	2024-03-10 20:38
export_report.pl	4.5 KB	-rwxr-xr-x	2024-03-10 20:38
extract-ikconfig	1.74 KB	-rwxr-xr-x	2024-03-10 20:38
extract-module-sig.pl	3.66 KB	-rwxr-xr-x	2024-03-10 20:38
extract-sys-certs.pl	3.75 KB	-rwxr-xr-x	2024-03-10 20:38
extract-vmlinux	1.66 KB	-rwxr-xr-x	2024-03-10 20:38
extract_xc3028.pl	44.62 KB	-rwxr-xr-x	2024-03-10 20:38
faddr2line	8.63 KB	-rwxr-xr-x	2024-03-10 20:38
file-size.sh	86 B	-rwxr-xr-x	2024-03-10 20:38
find-unused-docs.sh	1.27 KB	-rwxr-xr-x	2024-03-10 20:38
gcc-x86_32-has-stack-protector.sh	405 B	-rwxr-xr-x	2025-04-15 13:08
gcc-x86_64-has-stack-protector.sh	195 B	-rwxr-xr-x	2025-04-15 13:08
gen-randstruct-seed.sh	228 B	-rwxr-xr-x	2024-03-10 20:38
generate_initcall_order.pl	5.95 KB	-rwxr-xr-x	2024-03-10 20:38
generate_rust_analyzer.py	4.8 KB	-rwxr-xr-x	2024-03-10 20:38
generate_rust_target.rs	5.58 KB	-rw-r--r--	2024-03-10 20:38
get_abi.pl	25.36 KB	-rwxr-xr-x	2024-03-10 20:38
get_dvb_firmware	24.54 KB	-rwxr-xr-x	2024-03-10 20:38
get_feat.pl	14.61 KB	-rwxr-xr-x	2024-03-10 20:38
get_maintainer.pl	67.63 KB	-rwxr-xr-x	2024-03-10 20:38
gfp-translate	2.08 KB	-rwxr-xr-x	2025-04-15 13:08
git.orderFile	564 B	-rw-r--r--	2024-03-10 20:38
head-object-list.txt	1.36 KB	-rw-r--r--	2024-03-10 20:38
headerdep.pl	3.5 KB	-rwxr-xr-x	2024-03-10 20:38
headers_install.sh	2.76 KB	-rwxr-xr-x	2024-03-10 20:38
insert-sys-cert.c	13.08 KB	-rw-r--r--	2025-04-15 13:08
install.sh	986 B	-rwxr-xr-x	2024-03-10 20:38
jobserver-exec	2.56 KB	-rwxr-xr-x	2024-03-10 20:38
kallsyms.c	17.75 KB	-rw-r--r--	2025-04-15 13:08
kernel-doc	77.13 KB	-rwxr-xr-x	2025-04-15 13:08
ld-version.sh	1.82 KB	-rwxr-xr-x	2025-04-15 13:08
leaking_addresses.pl	12.84 KB	-rwxr-xr-x	2024-03-10 20:38
link-vmlinux.sh	7.66 KB	-rwxr-xr-x	2025-04-15 13:08
makelst	808 B	-rwxr-xr-x	2024-03-10 20:38
markup_oops.pl	7.92 KB	-rwxr-xr-x	2024-03-10 20:38
min-tool-version.sh	630 B	-rwxr-xr-x	2025-04-15 13:08
misc-check	509 B	-rwxr-xr-x	2024-03-10 20:38
mkcompile_h	642 B	-rwxr-xr-x	2024-03-10 20:38
mksysmap	2.08 KB	-rwxr-xr-x	2025-04-15 13:08
mkuboot.sh	414 B	-rwxr-xr-x	2024-03-10 20:38
module.lds.S	1.43 KB	-rw-r--r--	2025-04-15 13:08
modules-check.sh	443 B	-rwxr-xr-x	2024-03-10 20:38
nsdeps	1.63 KB	-rw-r--r--	2024-03-10 20:38
objdiff	2.83 KB	-rwxr-xr-x	2024-03-10 20:38
objdump-func	848 B	-rwxr-xr-x	2024-03-10 20:38
orc_hash.sh	316 B	-rw-r--r--	2024-03-10 20:38
pahole-version.sh	269 B	-rwxr-xr-x	2024-03-10 20:38
parse-maintainers.pl	4.54 KB	-rwxr-xr-x	2024-03-10 20:38
patch-kernel	9.95 KB	-rwxr-xr-x	2024-03-10 20:38
profile2linkerlist.pl	414 B	-rwxr-xr-x	2024-03-10 20:38
prune-kernel	912 B	-rwxr-xr-x	2024-03-10 20:38
recordmcount.c	17.51 KB	-rw-r--r--	2024-03-10 20:38
recordmcount.h	19.37 KB	-rw-r--r--	2024-03-10 20:38
recordmcount.pl	17.34 KB	-rwxr-xr-x	2024-03-10 20:38
relocs_check.sh	717 B	-rwxr-xr-x	2024-03-10 20:38
remove-stale-files	1.29 KB	-rwxr-xr-x	2024-03-10 20:38
rust_is_available.sh	9.48 KB	-rwxr-xr-x	2025-04-15 13:08
rust_is_available_bindgen_libclang.h	91 B	-rw-r--r--	2024-03-10 20:38
rust_is_available_test.py	17.7 KB	-rwxr-xr-x	2024-03-10 20:38
rustdoc_test_builder.rs	3.25 KB	-rw-r--r--	2024-03-10 20:38
rustdoc_test_gen.rs	9.48 KB	-rw-r--r--	2024-03-10 20:38
setlocalversion	5.18 KB	-rwxr-xr-x	2025-04-15 13:08
show_delta	3.04 KB	-rwxr-xr-x	2024-03-10 20:38
sign-file.c	9.93 KB	-rw-r--r--	2024-03-10 20:38
sorttable.c	7.68 KB	-rw-r--r--	2024-03-10 20:38
sorttable.h	12.85 KB	-rw-r--r--	2024-03-10 20:38
spdxcheck-test.sh	284 B	-rw-r--r--	2024-03-10 20:38
spdxcheck.py	15.23 KB	-rwxr-xr-x	2024-03-10 20:38
spdxexclude	417 B	-rw-r--r--	2024-03-10 20:38
spelling.txt	34.18 KB	-rw-r--r--	2024-03-10 20:38
sphinx-pre-install	25.07 KB	-rwxr-xr-x	2024-03-10 20:38
split-man.pl	604 B	-rwxr-xr-x	2024-03-10 20:38
stackdelta	1.84 KB	-rwxr-xr-x	2024-03-10 20:38
stackusage	794 B	-rwxr-xr-x	2024-03-10 20:38
subarch.include	647 B	-rw-r--r--	2024-03-10 20:38
syscallhdr.sh	1.89 KB	-rwxr-xr-x	2024-03-10 20:38
syscallnr.sh	1.45 KB	-rwxr-xr-x	2024-03-10 20:38
syscalltbl.sh	1.82 KB	-rwxr-xr-x	2025-04-15 13:08
tags.sh	10.73 KB	-rwxr-xr-x	2024-03-10 20:38
test_fortify.sh	2.23 KB	-rw-r--r--	2024-03-10 20:38
tools-support-relr.sh	726 B	-rwxr-xr-x	2024-03-10 20:38
unifdef.c	34.8 KB	-rw-r--r--	2024-03-10 20:38
ver_linux	2.59 KB	-rwxr-xr-x	2024-03-10 20:38
xen-hypercalls.sh	386 B	-rwxr-xr-x	2024-03-10 20:38
xz_wrap.sh	516 B	-rwxr-xr-x	2024-03-10 20:38

Rename

// SPDX-License-Identifier: GPL-2.0

//! Test builder for `rustdoc`-generated tests.
//!
//! This script is a hack to extract the test from `rustdoc`'s output. Ideally, `rustdoc` would
//! have an option to generate this information instead, e.g. as JSON output.
//!
//! The `rustdoc`-generated test names look like `{file}_{line}_{number}`, e.g.
//! `...path_rust_kernel_sync_arc_rs_42_0`. `number` is the "test number", needed in cases like
//! a macro that expands into items with doctests is invoked several times within the same line.
//!
//! However, since these names are used for bisection in CI, the line number makes it not stable
//! at all. In the future, we would like `rustdoc` to give us the Rust item path associated with
//! the test, plus a "test number" (for cases with several examples per item) and generate a name
//! from that. For the moment, we generate ourselves a new name, `{file}_{number}` instead, in
//! the `gen` script (done there since we need to be aware of all the tests in a given file).

use std::io::Read;

fn main() {
    let mut stdin = std::io::stdin().lock();
    let mut body = String::new();
    stdin.read_to_string(&mut body).unwrap();

// Find the generated function name looking for the inner function inside `main()`.
    //
    // The line we are looking for looks like one of the following:
    //
    // ```
    // fn main() { #[allow(non_snake_case)] fn _doctest_main_rust_kernel_file_rs_28_0() {
    // fn main() { #[allow(non_snake_case)] fn _doctest_main_rust_kernel_file_rs_37_0() -> Result<(), impl core::fmt::Debug> {
    // ```
    //
    // It should be unlikely that doctest code matches such lines (when code is formatted properly).
    let rustdoc_function_name = body
        .lines()
        .find_map(|line| {
            Some(
                line.split_once("fn main() {")?
                    .1
                    .split_once("fn ")?
                    .1
                    .split_once("()")?
                    .0,
            )
            .filter(|x| x.chars().all(|c| c.is_alphanumeric() || c == '_'))
        })
        .expect("No test function found in `rustdoc`'s output.");

// Qualify `Result` to avoid the collision with our own `Result` coming from the prelude.
    let body = body.replace(
        &format!("{rustdoc_function_name}() -> Result<(), impl core::fmt::Debug> {{"),
        &format!("{rustdoc_function_name}() -> core::result::Result<(), impl core::fmt::Debug> {{"),
    );

// For tests that get generated with `Result`, like above, `rustdoc` generates an `unwrap()` on
    // the return value to check there were no returned errors. Instead, we use our assert macro
    // since we want to just fail the test, not panic the kernel.
    //
    // We save the result in a variable so that the failed assertion message looks nicer.
    let body = body.replace(
        &format!("}} {rustdoc_function_name}().unwrap() }}"),
        &format!("}} let test_return_value = {rustdoc_function_name}(); assert!(test_return_value.is_ok()); }}"),
    );

// Figure out a smaller test name based on the generated function name.
    let name = rustdoc_function_name.split_once("_rust_kernel_").unwrap().1;

let path = format!("rust/test/doctests/kernel/{name}");

std::fs::write(path, body.as_bytes()).unwrap();
}