Hi,

the idea of adding a troubleshooting section to release notes was discussed shortly on IRC a few days ago between brane and myself (Bert was following the discussion too) in light of a user who ran into problems due to (presumably) some proxy issue with http-pipelining support.

To him, it seemed like it was a bug in SVN 1.9, since the same operation (locking multiple files) worked fine using SVN 1.8.

Ivan pointed out it's most likely a problem with the proxy (maybe it's not correctly supporting http pipelining).

Looking for a way to record such known issues, we concluded on IRC that the best way would be to document these things in a new troubleshooting section on the release notes pages.

Following is a patch against 1.10.html with the suggested section layout. If that passes, I'm planning to provide another patch for the 1.9 release notes covering problems due to the increased http-header-section size and issues with proxies (the two known cases atm which could cause users to run into problems when using 1.9 which wouldn't be encountered using 1.8).

[[[
Add a new troubleshooting section covering known issues which can be
encountered with the new version but are not directly bugs in Subversion
itself.

* docs/release-notes/1.10.html
  (troubleshooting): Add new section including a placeholder entry.
  (news): Add link to new troubleshooting section.
]]]

Regards,
Stefan
Index: 1.10.html
===================================================================
--- 1.10.html	(revision 1743444)
+++ 1.10.html	(working copy)
@@ -38,6 +38,8 @@
       >Many enhancements and bug fixes</a></li>
   <li><a href="#issues"
       >Known issues in the release</a></li>
+  <li><a href="#troubleshooting"
+      >Troubleshooting issues specific to this release</a></li>
 </ul>
 
 <p class="todo">TODO: remove 1.9 entries, left throughout this file as placeholders</p>
@@ -324,6 +326,31 @@
 
 </div>  <!-- issues -->
 
+<div class="h2" id="troubleshooting">
+<h2>Troubleshooting issues specific to this release
+  <a class="sectionlink" href="#troubleshooting"
+    title="Link to this section">&para;</a>
+</h2>
+
+<p>Subversion 1.10 introduces new features and makes use of new techniques
+which can trigger problems not encountered in previous versions. In contrast to
+known issues, things listed here are not due to some bug or issue in Subversion
+itself and therefore cannot be fixed with a new patch release.
+This section lists all known problems and provides instructions to solve them,
+if they occur.</p>
+
+<div class="h3" id="troubleshoot-placeholder">
+<h3>Placeholder for new issue
+  <a class="sectionlink" href="#no-op-changes"
+    title="Link to this section">&para;</a>
+</h3>
+
+<p class="todo">Add known issue or remove the placeholder</p>
+
+</div>  <!-- troubleshoot-placeholder -->
+
+</div>  <!-- troubleshooting -->
+
 <div class="h2" id="svn-1.8-deprecation">
 <h2>Subversion 1.8.x series no longer supported
   <a class="sectionlink" href="#svn-1.8-deprecation"

Reply via email to