summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Schwenke <martin@meltin.net>2020-05-14 09:57:24 +1000
committerStefan Metzmacher <metze@samba.org>2020-06-22 16:44:30 +0200
commit1c20b9596422c9cb92fc539493df45b03d91457b (patch)
treebbf6875af21da650766db829a1b8526b54f02273
parent19c3e87570954cb7fb4f6c105cbec9eabf4539b0 (diff)
downloadsocket_wrapper-1c20b9596422c9cb92fc539493df45b03d91457b.tar.gz
socket_wrapper-1c20b9596422c9cb92fc539493df45b03d91457b.tar.xz
socket_wrapper-1c20b9596422c9cb92fc539493df45b03d91457b.zip
doc: Document SOCKET_WRAPPER_DIR_ALLOW_ORIG
Signed-off-by: Martin Schwenke <martin@meltin.net> Reviewed-by: Andreas Schneider <asn@samba.org> Reviewed-by: Stefan Metzmacher <metze@samba.org>
-rw-r--r--doc/socket_wrapper.17
-rw-r--r--doc/socket_wrapper.1.txt10
2 files changed, 16 insertions, 1 deletions
diff --git a/doc/socket_wrapper.1 b/doc/socket_wrapper.1
index e244f10..ec7f4b8 100644
--- a/doc/socket_wrapper.1
+++ b/doc/socket_wrapper.1
@@ -1,7 +1,7 @@
'\" t
.\" Title: socket_wrapper
.\" Author: Samba Team
-.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 2018-11-28
.\" Manual: \ \&
.\" Source: \ \&
@@ -157,6 +157,11 @@ If you need to see what is going on in socket_wrapper itself or try to find a bu
.RS 4
This allows you to disable deep binding in socket_wrapper\&. This is useful for running valgrind tools or sanitizers like (address, undefined, thread)\&.
.RE
+.PP
+\fBSOCKET_WRAPPER_DIR_ALLOW_ORIG\fR
+.RS 4
+SOCKET_WRAPPER_DIR is resolved by socket_wrapper using realpath(3)\&. Given that Unix sockets are constructed relative to this directory, the resulting path can sometimes be too long to allow valid socket paths to be constructed due to length restrictions\&. Setting this variable (to any value) allows socket_wrapper to fall back to the original value of SOCKET_WRAPPER_DIR if realpath(3) makes it too long to be usable\&.
+.RE
.SH "EXAMPLE"
.sp
.if n \{\
diff --git a/doc/socket_wrapper.1.txt b/doc/socket_wrapper.1.txt
index c00d582..d070fbf 100644
--- a/doc/socket_wrapper.1.txt
+++ b/doc/socket_wrapper.1.txt
@@ -95,6 +95,16 @@ debug symbols.
This allows you to disable deep binding in socket_wrapper. This is useful for
running valgrind tools or sanitizers like (address, undefined, thread).
+*SOCKET_WRAPPER_DIR_ALLOW_ORIG*::
+
+SOCKET_WRAPPER_DIR is resolved by socket_wrapper using realpath(3).
+Given that Unix sockets are constructed relative to this directory,
+the resulting path can sometimes be too long to allow valid socket
+paths to be constructed due to length restrictions. Setting this
+variable (to any value) allows socket_wrapper to fall back to the
+original value of SOCKET_WRAPPER_DIR if realpath(3) makes it too long
+to be usable.
+
EXAMPLE
-------