diff options
author | James Prior <jep200404@columbus.rr.com> | 2016-11-30 22:20:04 -0500 |
---|---|---|
committer | James Prior <jep200404@columbus.rr.com> | 2016-11-30 22:21:16 -0500 |
commit | 614ec5c7d0a721deb97b5f522c6b31a233d79401 (patch) | |
tree | 7bc2fbb99fcd3e950009b174154f24ad1773e151 /docs/user-guides | |
parent | eede50f939927b3ddb4ba1ebb04b2988d6c3926e (diff) | |
download | mod_wsgi-614ec5c7d0a721deb97b5f522c6b31a233d79401.tar.gz |
docs/user-guides/*.rst: Use inline literals for all options.
Diffstat (limited to 'docs/user-guides')
-rw-r--r-- | docs/user-guides/application-issues.rst | 10 | ||||
-rw-r--r-- | docs/user-guides/checking-your-installation.rst | 14 | ||||
-rw-r--r-- | docs/user-guides/debugging-techniques.rst | 2 | ||||
-rw-r--r-- | docs/user-guides/installation-issues.rst | 8 | ||||
-rw-r--r-- | docs/user-guides/processes-and-threading.rst | 2 |
5 files changed, 18 insertions, 18 deletions
diff --git a/docs/user-guides/application-issues.rst b/docs/user-guides/application-issues.rst index 2eeee73..78cc9ca 100644 --- a/docs/user-guides/application-issues.rst +++ b/docs/user-guides/application-issues.rst @@ -338,8 +338,8 @@ If Apache is started automatically as 'root' when a machine is first booted it would inherit the user 'HOME' environment variable setting of the 'root' user. If however, Apache is started by a non privileged user via the 'sudo' command, it would inherit the 'HOME' environment variable of the user who -started it, unless the '-H' option had been supplied to 'sudo'. In the case -of the '-H' option being supplied, the 'HOME' environment variable of the +started it, unless the ``-H`` option had been supplied to 'sudo'. In the case +of the ``-H`` option being supplied, the 'HOME' environment variable of the 'root' user would again be used. Because the value of the 'HOME' environment variable can vary based on how @@ -866,7 +866,7 @@ directive should be used and the group set to '%{GLOBAL}':: WSGIApplicationGroup %{GLOBAL} Extension modules for which this is known to be necessary are any which -have been developed using SWIG and for which the '-threads' option was +have been developed using SWIG and for which the ``-threads`` option was supplied to 'swig' when the bindings were generated. One example of this is the 'dbxml' module, a Python wrapper for the Berkeley Database, previously developed by !SleepyCat Software, but now managed by Oracle. Another package @@ -876,7 +876,7 @@ There is also a bit of a question mark over the Python Subversion bindings. This package also uses SWIG, however it is only some versions that appear to require that the very first sub interpreter created when Python is initialised be used. It is currently believed that this may be more to do -with coding problems than with the '-threads' option being passed to the +with coding problems than with the ``-threads`` option being passed to the 'swig' command when the bindings were generated. For all the affected packages, as described above it is believed though @@ -884,7 +884,7 @@ that they will work when application group is set to force the application to run in the first interpreter created by Python as described above. Another option for packages which use SWIG generated bindings is not to use -the '-threads' option when 'swig' is used to generate the bindings. This +the ``-threads`` option when 'swig' is used to generate the bindings. This will avoid any problems and allow the package to be used in any sub interpreter. Do be aware though that by disabling thread support in SWIG bindings, that the GIL isn't released when C code is entered. The diff --git a/docs/user-guides/checking-your-installation.rst b/docs/user-guides/checking-your-installation.rst index e132964..bf93133 100644 --- a/docs/user-guides/checking-your-installation.rst +++ b/docs/user-guides/checking-your-installation.rst @@ -25,7 +25,7 @@ Apache Build Information Information related to what version of Apache is being used and how it is built is obtained in a number of ways. The primary means is from the Apache 'httpd' executable itself using command line options. The main such -option is the '-V' option. +option is the ``-V`` option. On most systems the standard Apache executable supplied with the operating system is located at '/usr/sbin/httpd'. On MacOS X, for the operating system @@ -112,11 +112,11 @@ at run time based on Apache configuration files. If modules have been statically compiled into Apache, usually it would be evident by what 'configure' arguments have been used when Apache was built. -To verify what exactly what is compiled in statically, you can use the '-l' +To verify what exactly what is compiled in statically, you can use the ``-l`` option to the Apache executable. On MacOS X, for the operating system supplied Apache the output from -running '-l' option is:: +running ``-l`` option is:: $ /usr/sbin/httpd -l Compiled in modules: @@ -130,10 +130,10 @@ This is actually the Apache module that handles the task of dynamically loading other Apache modules. For a specific Apache configuration, you can determine what Apache modules -will be loaded dynamically by using the '-M' option for the Apache executable. +will be loaded dynamically by using the ``-M`` option for the Apache executable. On MacOS X, for the operating system supplied Apache the output from -running '-M' option, where the only additional module added is mod_wsgi, +running ``-M`` option, where the only additional module added is mod_wsgi, is:: $ /usr/sbin/httpd -M @@ -249,7 +249,7 @@ checks about what is the prefered mechanism for a particular operating system. Which mechanism is used by default can be determined from the build -information displayed by the '-V' option to the Apache executable described +information displayed by the ``-V`` option to the Apache executable described previously. The particular entries of interest are those with 'SERIALIZE' in the name of the macro. @@ -321,7 +321,7 @@ and:: WSGIAcceptMutex xxx -For each run the '-t' option on the Apache program executable. +For each run the ``-t`` option on the Apache program executable. On MacOS X, with the operating system supplied APR library, this yields:: diff --git a/docs/user-guides/debugging-techniques.rst b/docs/user-guides/debugging-techniques.rst index d14e4f8..13d47e8 100644 --- a/docs/user-guides/debugging-techniques.rst +++ b/docs/user-guides/debugging-techniques.rst @@ -747,7 +747,7 @@ interpreter created when Python is initialised. In this latter issue, the sub interpreter problems can often be solved by forcing the WSGI application using the Python Subversion modules to run in the '%{GLOBAL}' application group. This solution often also resolves issues -with SWIG generated bindings, especially where the '-thread' option was +with SWIG generated bindings, especially where the ``-thread`` option was supplied to 'swig' when the bindings were generated. Whatever the reason, in some cases the only way to determine why Apache or diff --git a/docs/user-guides/installation-issues.rst b/docs/user-guides/installation-issues.rst index 9c83d6c..0bc9940 100644 --- a/docs/user-guides/installation-issues.rst +++ b/docs/user-guides/installation-issues.rst @@ -38,7 +38,7 @@ To remedy the problem, install the developer package for Python corresponding to the Python runtime package you have installed. What the name of the developer package is can vary from one Linux distribution to another. Normally it has the same name as the Python runtime package with -'-dev' appended to the package name. You will need to lookup up list of +``-dev`` appended to the package name. You will need to lookup up list of available packages in your packaging system to determine actual name of package to install. @@ -406,9 +406,9 @@ The error encountered would be similar to:: load /etc/httpd/modules/mod_wsgi.so into server: \ /etc/httpd/modules/mod_wsgi.so: undefined symbol: forkpty -This problem can be fixed by adding '-lutil' to the list of libraries to +This problem can be fixed by adding ``-lutil`` to the list of libraries to link mod_wsgi against when it is being built. This can be done by adding -'-lutil' to the 'LDLIBS' variable in the mod_wsgi 'Makefile' after having +``-lutil`` to the 'LDLIBS' variable in the mod_wsgi 'Makefile' after having run 'configure'. An alternative method which may work is to edit the 'envvars' file, if it @@ -470,7 +470,7 @@ configured for maintainer mode:: Specifically, whoever built the version of Apache being used supplied the option ``--enable-maintainer-mode`` when configuring Apache prior to installation. You would be able to tell at the time of compiling mod_wsgi -if this has been done as the option '-DAP_DEBUG' would be supplied to the +if this has been done as the option ``-DAP_DEBUG`` would be supplied to the compiler when mod_wsgi source code is compiled. These warnings can be ignored, but in general you shouldn't run Apache in diff --git a/docs/user-guides/processes-and-threading.rst b/docs/user-guides/processes-and-threading.rst index 40ec65e..b48c3ea 100644 --- a/docs/user-guides/processes-and-threading.rst +++ b/docs/user-guides/processes-and-threading.rst @@ -82,7 +82,7 @@ running the 'configure' script for Apache. The main alternative to the 'prefork' MPM which can be used on UNIX systems is the 'worker' MPM. If you are unsure which MPM is built into Apache, it can be determined -by running the Apache web server executable with the '-V' option. The +by running the Apache web server executable with the ``-V`` option. The output from running the web server executable with this option will be information about how it was configured when built:: |