Uploaded image for project: 'Log4j 2'
  1. Log4j 2
  2. LOG4J2-956

Manual refers to Route "AppenderRef" attribute, should be "ref"

    Details

      Description

      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:

      ---
       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)
      

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              davidkellerman David Kellerman
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 0.25h
                0.25h
                Remaining:
                Remaining Estimate - 0.25h
                0.25h
                Logged:
                Time Spent - Not Specified
                Not Specified