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

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.1
• Fix Version/s: 2.2
• Component/s: Documentation
• Labels: documentation newbie patch
• Assignee: Unassigned
• Reporter: David Kellerman
• Created: 20/Feb/15 06:25
• Updated: 21/Feb/15 04:55
• Resolved: 21/Feb/15 04:55

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)