From 3568f0b55d035210982cf2d5844b23e249c15ad3 Mon Sep 17 00:00:00 2001
From: Trevor Daniels <t.daniels@treda.co.uk>
Date: Thu, 15 Jul 2010 10:29:19 +0100
Subject: [PATCH] Docs: CG: add warning not to split cross-refs
---
Documentation/contributor/doc-work.itexi | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi
index c002698f1c..c5554ad440 100644
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -535,7 +535,9 @@ command ;)
@unnumberedsubsubsec Cross references
Enter the exact @code{@@node} name of the target reference between
-the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}).
+the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}). Do not
+split a cross-reference across two lines -- this causes the
+cross-reference to be rendered incorrectly in html documents.
@itemize
@item
--
2.39.5