Skip to content

Minimal fixes to documentation of Context and Host #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rrodewald wants to merge 5 commits into from
Closed

Minimal fixes to documentation of Context and Host #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f0826c1
Minimal fixes to documentation of Context and Host
Aug 4, 2021
b2f7f8b
Consistent tagging of appBase as code
Aug 4, 2021
5307a73
Merge branch 'apache:main' into documentation-fixes
rrodewald Aug 4, 2021
c88622a
Rewording of default values.
Aug 4, 2021
b880718
Consistently tagged docBase attribute as code
Aug 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions webapps/docs/config/context.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@
<ul>
<li>Disable autoDeploy and deployOnStartup and define all
<strong>Context</strong>s in server.xml</li>
<li>Locate the WAR and/or directory outside of the Host&apos;s appBase and use
a context.xml file with a docBase attribute to define it.</li>
<li>Locate the WAR and/or directory outside of the Host&apos;s <code>appBase</code> and use
a context.xml file with a <code>docBase</code> attribute to define it.</li>
</ul>
</subsection>

Expand Down Expand Up @@ -263,14 +263,14 @@
<attributes>

<attribute name="allowCasualMultipartParsing" required="false">
<p>Set to true if Tomcat should automatically parse
<p>Set to <code>true</code> if Tomcat should automatically parse
multipart/form-data request bodies when HttpServletRequest.getPart*
or HttpServletRequest.getParameter* is called, even when the
target servlet isn't marked with the @MultipartConfig annotation
(See Servlet Specification 3.0, Section 3.2 for details).
Note that any setting other than <code>false</code> causes Tomcat
to behave in a way that is not technically spec-compliant.
The default is <code>false</code></p>
The default is <code>false</code>.</p>
</attribute>

<attribute name="allowMultipleLeadingForwardSlashInPath" required="false">
Expand Down Expand Up @@ -393,7 +393,7 @@
<p>The value of this field must not be set unless the Context element is
defined in server.xml or the <code>docBase</code> is not located under
the <a href="host.html">Host</a>&apos;s <code>appBase</code>.</p>
<p>If a symbolic link is used for docBase then changes to the
<p>If a symbolic link is used for <code>docBase</code> then changes to the
symbolic link will only be effective after a Tomcat restart or
by undeploying and redeploying the context. A context reload is not
sufficient.</p>
Expand Down Expand Up @@ -475,12 +475,12 @@
will process all requests not assigned to other Contexts.</p>
<p>This attribute must only be used when statically defining a Context
in server.xml. In all other circumstances, the path will be inferred
from the filenames used for either the .xml context file or the docBase.
from the filenames used for either the .xml context file or the <code>docBase</code>.
</p>
<p>Even when statically defining a Context in server.xml, this attribute
must not be set unless either the docBase is not located under the
must not be set unless either the <code>docBase</code> is not located under the
<a href="host.html">Host</a>&apos;s <code>appBase</code> or both
<code>deployOnStartup</code> and <code>autoDeploy</code> are false. If
<code>deployOnStartup</code> and <code>autoDeploy</code> are <code>false</code>. If
this rule is not followed, double deployment is likely to result.</p>
</attribute>

Expand Down Expand Up @@ -594,7 +594,7 @@
</attribute>

<attribute name="swallowAbortedUploads" required="false">
<p>Set to false if Tomcat should <b>not</b> read any additional request
<p>Set to <code>false</code> if Tomcat should <b>not</b> read any additional request
body data for aborted uploads and instead abort the client connection.
This setting is used in the following situations:
</p>
Expand Down Expand Up @@ -757,7 +757,7 @@
</attribute>

<attribute name="antiResourceLocking" required="false">
<p>If true, Tomcat will prevent any file locking.
<p>If <code>true</code>, Tomcat will prevent any file locking.
This will significantly impact startup time of applications,
but allows full webapp hot deploy and undeploy on platforms
or configurations where file locking can occur.
Expand All @@ -768,12 +768,12 @@
see <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=37668">
Bugzilla 37668</a>.</p>

<p>Please note that setting this flag to true in applications that are
outside the appBase for the Host (the <code>webapps</code> directory
<p>Please note that setting this flag to <code>true</code> in applications that are
outside the <code>appBase</code> for the Host (the <code>webapps</code> directory
by default) will cause the application to be <strong>deleted</strong> on
Tomcat shutdown. You probably don't want to do this, so think twice
before setting antiResourceLocking=true on a webapp that's outside the
appBase for its Host.</p>
<code>appBase</code> for its Host.</p>
</attribute>

<attribute name="clearReferencesHttpClientKeepAliveThread" required="false">
Expand Down Expand Up @@ -844,7 +844,7 @@
is deployed. On subsequent starts, the copied context XML descriptor
will be used in preference to any context XML descriptor embedded inside
the application even if the descriptor embedded inside the application
is more recent. The flag's value defaults to <code>false</code>. Note if
is more recent. The default is <code>false</code>. Note if
the <strong>deployXML</strong> attribute of the owning
<a href="host.html">Host</a> is <code>false</code> or if the
<strong>copyXML</strong> attribute of the owning
Expand All @@ -858,7 +858,7 @@
createSubContext(), destroySubContext() or close() will trigger a
<code>javax.naming.OperationNotSupportedException</code> as required by
section EE.5.3.4 of the Jakarta EE specification. This exception can be
disabled by setting this attribute to false in which case any calls to
disabled by setting this attribute to <code>false</code> in which case any calls to
modify the JNDI context will return <b>without</b> making any changes
and methods that return values will return <code>null</code>. If not
specified, the specification compliant default of <code>true</code> will
Expand Down Expand Up @@ -1264,7 +1264,7 @@
it is no longer required. This is intended to speed up clean-up of
resources that would otherwise happen as part of garbage collection.
This attribute is ignored if the <code>singleton</code> attribute is
false.</p>
<code>false</code>.</p>
<p>For <code>javax.sql.DataSource</code> and
<code>javax.sql.XADataSource</code> resources that implement
<code>AutoCloseable</code> such as Apache Commons DBCP 2 and the default
Expand Down
26 changes: 13 additions & 13 deletions webapps/docs/config/host.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,21 +110,21 @@
</attribute>

<attribute name="createDirs" required="false">
<p>If set to true, Tomcat will attempt to create the directories defined
<p>If set to <code>true</code>, Tomcat will attempt to create the directories defined
by the attributes <code>appBase</code> and <code>xmlBase</code> during
the startup phase. The default value is <code>true</code>. If set to
true, and directory creation fails, an error message will be printed out
<code>true</code>, and directory creation fails, an error message will be printed out
but will not halt the startup sequence.</p>
</attribute>

<attribute name="autoDeploy" required="false">
<p>This flag value indicates if Tomcat should check periodically for new
or updated web applications while Tomcat is running. If true, Tomcat
or updated web applications while Tomcat is running. If <code>true</code>, Tomcat
periodically checks the <code>appBase</code> and <code>xmlBase</code>
directories and deploys any new web applications or context XML
descriptors found. Updated web applications or context XML descriptors
will trigger a reload of the web application. The flag's value defaults
to true. See
will trigger a reload of the web application. The default
is <code>true</code>. See
<a href="#Automatic_Application_Deployment">Automatic Application
Deployment</a> for more information.</p>
</attribute>
Expand Down Expand Up @@ -169,8 +169,8 @@

<attribute name="deployOnStartup" required="false">
<p>This flag value indicates if web applications from this host should
be automatically deployed when Tomcat starts. The flag's value defaults
to true. See
be automatically deployed when Tomcat starts. The default
is <code>true</code>. See
<a href="#Automatic_Application_Deployment">Automatic Application
Deployment</a> for more information.</p>
</attribute>
Expand Down Expand Up @@ -233,8 +233,8 @@
<p>This flag determines if Tomcat, as part of the auto deployment
process, will check for old, unused versions of web applications
deployed using parallel deployment and, if any are found, remove them.
This flag only applies if <code>autoDeploy</code> is true. If not
specified the default value of false will be used.</p>
This flag only applies if <code>autoDeploy</code> is <code>true</code>. If not
specified the default value of <code>false</code> will be used.</p>
</attribute>

</attributes>
Expand All @@ -258,8 +258,8 @@
when the application is deployed. On subsequent starts, the copied
context XML descriptor will be used in preference to any context XML
descriptor embedded inside the application even if the descriptor
embedded inside the application is more recent. The flag's value
defaults to <code>false</code>. Note if <strong>deployXML</strong>
embedded inside the application is more recent. The default
is <code>false</code>. Note if <strong>deployXML</strong>
is <code>false</code>, this attribute will have no effect.</p>
</attribute>

Expand All @@ -276,7 +276,7 @@
descriptor is present in <strong>xmlBase</strong> then the context will
fail to start in case the descriptor contains necessary configuration
for secure deployment (such as a RemoteAddrValve) which should not be
ignored. The flag's value defaults to <code>true</code> unless a
ignored. The default is <code>true</code> unless a
security manager is enabled when the default is <code>false</code>.
When running under a security manager this may be enabled on a per web
application basis by granting the
Expand All @@ -302,7 +302,7 @@
placed in the <code>appBase</code> directory as web application
archive (WAR) files to be unpacked into a corresponding disk directory
structure, <code>false</code> to run such web applications directly
from a WAR file. See
from a WAR file. The default is <code>true</code>. See
<a href="#Automatic_Application_Deployment">Automatic Application
Deployment</a> for more information.</p>
<p>Note: If Tomcat expands the WAR file then it will add a file
Expand Down