Skip to content

man/labgrid-client: mention LG_PROXY requirements for exporter resources#1807

Open
rohieb wants to merge 2 commits intolabgrid-project:masterfrom
rohieb:man-client-LG_PROXY-resources
Open

man/labgrid-client: mention LG_PROXY requirements for exporter resources#1807
rohieb wants to merge 2 commits intolabgrid-project:masterfrom
rohieb:man-client-LG_PROXY-resources

Conversation

@rohieb
Copy link
Copy Markdown
Contributor

@rohieb rohieb commented Jan 27, 2026

Small consistency patch for readers of the man page that wonder about how to reach ressources on remote exporters when using LG_PROXY. While at it, correct a few typos.

Checklist

  • Documentation for the feature
  • PR has been tested
  • Man pages have been regenerated

@rohieb rohieb requested a review from krevsbech as a code owner January 27, 2026 11:21
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.7%. Comparing base (bfb6ff2) to head (f45b02f).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #1807   +/-   ##
======================================
  Coverage    46.7%   46.7%           
======================================
  Files         179     179           
  Lines       14202   14202           
======================================
  Hits         6645    6645           
  Misses       7557    7557           
Flag Coverage Δ
3.10 46.7% <ø> (ø)
3.11 46.7% <ø> (ø)
3.12 46.7% <ø> (ø)
3.13 46.7% <ø> (ø)
3.14 ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rohieb rohieb changed the title Man client lg proxy resources man/labgrid-client: mention LG_PROXY requirements for exporter resources Jan 27, 2026
@rohieb
Copy link
Copy Markdown
Contributor Author

rohieb commented Jan 27, 2026

Hm.

The manual pages are in .build/man.
make[1]: Leaving directory '/home/runner/work/labgrid/labgrid/doc'
cp ../doc/.build/man/labgrid-client.1 labgrid-client.1
cp ../doc/.build/man/labgrid-coordinator.1 labgrid-coordinator.1
cp ../doc/.build/man/labgrid-exporter.1 labgrid-exporter.1
cp ../doc/.build/man/labgrid-device-config.5 labgrid-device-config.5
cp ../doc/.build/man/labgrid-pytest.7 labgrid-pytest.7
cp ../doc/.build/man/labgrid-suggest.1 labgrid-suggest.1
make: Leaving directory '/home/runner/work/labgrid/labgrid/man'
diff --git a/man/labgrid-client.1 b/man/labgrid-client.1
index b78c566..6d20632 100644
--- a/man/labgrid-client.1
+++ b/man/labgrid-client.1
@@ -1119,7 +1119,7 @@ directly.
 .sp
 Note: this proxy is only used to connect to the coordinator.
 Additional steps may be required to connect to ressources.
-See <\%<https://\:labgrid\:.readthedocs\:.io/\:en/\:latest/\:overview\:.html#\:proxy-mechanism>>
+See <\X'tty: link https://labgrid.readthedocs.io/en/latest/overview.html#proxy-mechanism'\fI\%https://labgrid.readthedocs.io/en/latest/overview.html#proxy\-mechanism\fP\X'tty: link'>
 (or the file \fBdoc/overview.rst\fP in the labgrid source tree)
 for more information.
 .SS LG_HOSTNAME
Error: Process completed with exit code 1.

I have no idea where that diff comes from; I've created a brand-new venv and ran make -C man and this is what came from it.

@Emantor Emantor force-pushed the man-client-LG_PROXY-resources branch from 81bb7ef to 9a58659 Compare January 30, 2026 12:33
rohieb added 2 commits March 28, 2026 14:38
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
The requirements are already documented, but the man page for
labgrid-client does not mention it. Link to the respective doc.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
@Emantor Emantor force-pushed the man-client-LG_PROXY-resources branch from 9a58659 to f45b02f Compare March 28, 2026 13:38
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