You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by "Gary Gregory (JIRA)" <ji...@apache.org> on 2015/02/20 22:53:11 UTC

[jira] [Resolved] (LOG4J2-956) Manual refers to Route "AppenderRef" attribute, should be "ref"

     [ https://issues.apache.org/jira/browse/LOG4J2-956?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gary Gregory resolved LOG4J2-956.
---------------------------------
    Resolution: Fixed

Fixed {{configuration.xml.vm}}. The other file was OK in git master. Please verify and close.

> Manual refers to Route "AppenderRef" attribute, should be "ref"
> ---------------------------------------------------------------
>
>                 Key: LOG4J2-956
>                 URL: https://issues.apache.org/jira/browse/LOG4J2-956
>             Project: Log4j 2
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 2.1
>            Reporter: David Kellerman
>            Priority: Minor
>              Labels: documentation, newbie, patch
>   Original Estimate: 0.25h
>  Remaining Estimate: 0.25h
>
> There are several places in the manual that refer to a Route "AppenderRef" attribute which should instead specify the "ref" attribute.
>     
> This inconsistency was previously noted in issue LOG4J2-482, but I found a few places that still refer to AppenderRef. 
> Here's a patch that should catch the rest of them: 
> {noformat}
> ---
>  src/site/xdoc/manual/appenders.xml        | 2 +-
>  src/site/xdoc/manual/configuration.xml.vm | 8 ++++----
>  2 files changed, 5 insertions(+), 5 deletions(-)
> diff --git a/src/site/xdoc/manual/appenders.xml b/src/site/xdoc/manual/appenders.xml
> index abe0c9a..037ecbb 100644
> --- a/src/site/xdoc/manual/appenders.xml
> +++ b/src/site/xdoc/manual/appenders.xml
> @@ -2632,7 +2632,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity {
>                can be configured as the default.
>              </p>
>              <p>
> -              Each Route must reference an Appender. If the Route contains an AppenderRef attribute then the
> +              Each Route must reference an Appender. If the Route contains a ref attribute then the
>                Route will reference an Appender that was defined in the configuration. If the Route contains an
>                Appender definition then an Appender will be created within the context of the RoutingAppender and
>                will be reused each time a matching Appender name is referenced through a Route.
> diff --git a/src/site/xdoc/manual/configuration.xml.vm b/src/site/xdoc/manual/configuration.xml.vm
> index 7b1fd53..feeab2f 100644
> --- a/src/site/xdoc/manual/configuration.xml.vm
> +++ b/src/site/xdoc/manual/configuration.xml.vm
> @@ -847,8 +847,8 @@ public class Bar {
>              <SizeBasedTriggeringPolicy size="500" />
>            </RollingFile>
>          </Route>
> -        <Route AppenderRef="STDOUT" key="Audit"/>
> -        <Route AppenderRef="List" key="Service"/>
> +        <Route ref="STDOUT" key="Audit"/>
> +        <Route ref="List" key="Service"/>
>        </Routes>
>      </Routing>
>    </Appenders>
> @@ -1077,8 +1077,8 @@ public class Bar {
>              <SizeBasedTriggeringPolicy size="500" />
>            </RollingFile>
>          </Route>
> -        <Route AppenderRef="STDOUT" key="Audit"/>
> -        <Route AppenderRef="List" key="Service"/>
> +        <Route ref="STDOUT" key="Audit"/>
> +        <Route ref="List" key="Service"/>
>        </Routes>
>      </Routing>
>    </Appenders>
> -- 
> 1.9.3 (Apple Git-50)
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org