65 lines
2.5 KiB
Diff
65 lines
2.5 KiB
Diff
From a518da9fdc54e3652f67d92d266106017145c62b Mon Sep 17 00:00:00 2001
|
|
From: "Richard W.M. Jones" <rjones@redhat.com>
|
|
Date: Sun, 24 Aug 2025 18:54:47 +0100
|
|
Subject: [PATCH] docs: Minor copyediting to export name documentation
|
|
|
|
---
|
|
generator/API.ml | 24 ++++++++++++++++--------
|
|
1 file changed, 16 insertions(+), 8 deletions(-)
|
|
|
|
diff --git a/generator/API.ml b/generator/API.ml
|
|
index 3ebc1912..3ab3aacb 100644
|
|
--- a/generator/API.ml
|
|
+++ b/generator/API.ml
|
|
@@ -478,15 +478,19 @@ handle with this information.";
|
|
permitted_states = [ Created; Negotiating ];
|
|
shortdesc = "set the export name";
|
|
longdesc = "\
|
|
-For servers which require an export name or can serve different
|
|
-content on different exports, set the C<export_name> to
|
|
-connect to. The default is the empty string C<\"\">.
|
|
+Some NBD servers can serve multiple disk images (\"exports\").
|
|
+The export is picked by the client, by requesting an export name
|
|
+during the negotiation phase. The default export is the
|
|
+empty string C<\"\">.
|
|
|
|
+Some NBD servers ignore this and serve the same content regardless.
|
|
This is only relevant when connecting to servers using the
|
|
newstyle protocol as the oldstyle protocol did not support
|
|
-export names. The NBD protocol limits export names to
|
|
-4096 bytes, but servers may not support the full length.
|
|
-The encoding of export names is always UTF-8.
|
|
+export names.
|
|
+
|
|
+The NBD protocol limits export names to 4096 bytes, but servers
|
|
+may not support the full length. The encoding of export names
|
|
+is always UTF-8.
|
|
|
|
When option mode is not in use, the export name must be set
|
|
before beginning a connection. However, when L<nbd_set_opt_mode(3)>
|
|
@@ -498,7 +502,9 @@ be used to learn details about an export before connecting.
|
|
|
|
This call may be skipped if using L<nbd_connect_uri(3)> to connect
|
|
to a URI that includes an export name.";
|
|
- see_also = [Link "get_export_name"; Link "connect_uri";
|
|
+ see_also = [Link "get_export_name";
|
|
+ Link "get_canonical_export_name";
|
|
+ Link "connect_uri";
|
|
Link "set_opt_mode"; Link "opt_go"; Link "opt_list";
|
|
Link "opt_info"];
|
|
};
|
|
@@ -603,7 +609,9 @@ C<\"\">).
|
|
Some servers are unlikely to report a canonical name unless the
|
|
client specifically hinted about wanting it, via L<nbd_set_full_info(3)>.";
|
|
example = Some "examples/server-flags.c";
|
|
- see_also = [Link "set_full_info"; Link "get_export_name";
|
|
+ see_also = [Link "set_full_info";
|
|
+ Link "set_export_name";
|
|
+ Link "get_export_name";
|
|
Link "opt_info"];
|
|
};
|
|
|
|
--
|
|
2.47.1
|
|
|