Skip to content

doc: change: drop --load from the opp_repl commands in the INET tree - #1376

Open
levy wants to merge 1 commit into
masterfrom
topic/tests-on-opp-repl-short-commands
Open

levy wants to merge 1 commit into
masterfrom
topic/tests-on-opp-repl-short-commands

Conversation

@levy

@levy levy commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

The documentation writes each fingerprint command as opp_run_fingerprint_tests --load $INET_ROOT -p inet .... In the INET tree, the two options are not necessary, and they make each example longer and harder to remember. This pull request explains the rule once and uses the short form, for example opp_run_fingerprint_tests -f wireless, on the other pages.

The short form works because opp_repl c24d2c6 (now on main and github_ci) makes a command look for *.opp files in the current folder and then in its parent folders, as git finds its repository. So in each folder of the INET tree a command finds INET's inet.opp, and it finds the project from the current folder; in a subfolder, a command without a filter tests only that subfolder. The developer guide gives the --load $INET_ROOT -p inet form for a folder outside the INET tree. The script tests/fingerprint/fingerprinttest_selfdoc and the workflows keep the long form, so that they do not depend on the current folder.

Commits

  • 6d9097b doc: change: drop --load from the opp_repl commands in the INET tree

Evidence

In a podman copy of the GitHub job (ubuntu 24.04, clang 16) with opp_repl c24d2c6, the short form gives the 3 PASS of examples/empty from the INET root with -f examples/empty, from examples/empty without an option and from tests/fingerprint with -f examples/empty. In /tmp, the command finds no project without an option, and gives the 3 PASS with --load $INET_ROOT -p inet.

Not verified: the HTML build of the developer guide and the tutorial (the changes are inside existing paragraphs and code blocks).

🤖 Generated with Claude Code

The documentation wrote each fingerprint command as `opp_run_fingerprint_tests --load $INET_ROOT -p inet ...`. In the INET tree, the two options are not necessary, and they make each example longer.

opp_repl c24d2c6 makes a command look for *.opp files in the current folder and then in its parent folders, as git finds its repository. So in each folder of the INET tree a command finds INET's inet.opp, and it finds the project from the current folder. The developer guide explains this once, with the --load $INET_ROOT -p inet form for a folder outside the INET tree, and the other pages use the short form. The comment of inet.opp says the same. The script fingerprinttest_selfdoc and the workflows keep the long form, so that they do not depend on the current folder.

Checked in the GitHub-job container with opp_repl c24d2c6: the short form gives the 3 PASS of examples/empty from the INET root with -f, from examples/empty without an option and from tests/fingerprint with -f. In /tmp, the command finds no project without an option, and gives the 3 PASS with --load $INET_ROOT -p inet.

Plan: plan/pending/tests-on-opp-repl.md

Change: doc | behavior.change | - | tests-on-opp-repl

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant