From 9be652f8ffa7df69b11846ed1c9079f84c8e6697 Mon Sep 17 00:00:00 2001
From: Jon Siwek <jsiwek@ncsa.illinois.edu>
Date: Wed, 30 Nov 2011 10:13:20 -0600
Subject: [PATCH] Rearrange packet filter and dpd documentation.

---
 doc/index.rst                                 |  1 -
 doc/scripts/common.rst                        | 19 -------------------
 doc/scripts/index.rst                         |  4 ++--
 src/BroDoc.cc                                 |  6 ++++--
 .../doc.autogen-reST-example/example.rst      |  4 ++--
 5 files changed, 8 insertions(+), 26 deletions(-)
 delete mode 100644 doc/scripts/common.rst

diff --git a/doc/index.rst b/doc/index.rst
index ad503af50b..33f47ef151 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -39,7 +39,6 @@ Script Reference
 .. toctree::
    :maxdepth: 1
 
-   scripts/common
    scripts/builtins
    scripts/bifs
    scripts/packages
diff --git a/doc/scripts/common.rst b/doc/scripts/common.rst
deleted file mode 100644
index 6105585b2c..0000000000
--- a/doc/scripts/common.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-Common Documentation
-====================
-
-.. _common_port_analysis_doc:
-
-Port Analysis
--------------
-
-TODO: add some stuff here
-
-.. _common_packet_filter_doc:
-
-Packet Filter
--------------
-
-TODO: add some stuff here
-
-.. note:: Filters are only relevant when dynamic protocol detection (DPD)
-          is explicitly turned off (Bro release 1.6 enabled DPD by default).
diff --git a/doc/scripts/index.rst b/doc/scripts/index.rst
index 5de203afe7..bf0fa25f10 100644
--- a/doc/scripts/index.rst
+++ b/doc/scripts/index.rst
@@ -1,7 +1,7 @@
 .. This is a stub doc to which broxygen appends during the build process
 
-Index of All Bro Scripts
-========================
+Index of All Individual Bro Scripts
+===================================
 
 .. toctree::
    :maxdepth: 1
diff --git a/src/BroDoc.cc b/src/BroDoc.cc
index b84b9d023d..91aed5ec62 100644
--- a/src/BroDoc.cc
+++ b/src/BroDoc.cc
@@ -215,14 +215,16 @@ void BroDoc::WriteDocFile() const
 	if ( ! port_analysis.empty() )
 		{
 		WriteSectionHeading("Port Analysis", '-');
-		WriteToDoc(":ref:`More Information <common_port_analysis_doc>`\n\n");
+		WriteToDoc("Loading this script makes the following changes to "
+		           ":bro:see:`dpd_config`.\n\n");
 		WriteStringList("%s", port_analysis);
 		}
 
 	if ( ! packet_filter.empty() )
 		{
 		WriteSectionHeading("Packet Filter", '-');
-		WriteToDoc(":ref:`More Information <common_packet_filter_doc>`\n\n");
+		WriteToDoc("Loading this script makes the following changes to "
+		           ":bro:see:`capture_filters`.\n\n");
 		WriteToDoc("Filters added::\n\n");
 		WriteToDoc("%s\n", packet_filter.c_str());
 		}
diff --git a/testing/btest/Baseline/doc.autogen-reST-example/example.rst b/testing/btest/Baseline/doc.autogen-reST-example/example.rst
index 880fa0e171..7c61277187 100644
--- a/testing/btest/Baseline/doc.autogen-reST-example/example.rst
+++ b/testing/btest/Baseline/doc.autogen-reST-example/example.rst
@@ -281,7 +281,7 @@ Redefinitions
 
 Port Analysis
 -------------
-:ref:`More Information <common_port_analysis_doc>`
+Loading this script makes the following changes to :bro:see:`dpd_config`.
 
 SSL::
 
@@ -292,7 +292,7 @@ SSL::
 
 Packet Filter
 -------------
-:ref:`More Information <common_packet_filter_doc>`
+Loading this script makes the following changes to :bro:see:`capture_filters`.
 
 Filters added::