[sagemath] 01/01: Some more doc tweaks

[Ximin Luo]

This is an automated email from the git hooks/post-receive script.

infinity0 pushed a commit to branch master
in repository sagemath.

commit 8f5cb94f5e8795492f163b2f2e722f31ec69a531
Author: Ximin Luo <infinity0 at debian.org>
Date:   Sun Dec 4 13:52:39 2016 +0100

    Some more doc tweaks
---
 debian/README.Debian | 42 ++++++++++++++++++++----------------------
 debian/README.source | 11 +++++++----
 2 files changed, 27 insertions(+), 26 deletions(-)

diff --git a/debian/README.Debian b/debian/README.Debian
index 75d04dc..a8bd72a 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -14,28 +14,6 @@ the package documentation for details. Help is needed!
 
 python-sagenb: SageNB HTTPS unsupported, because certtool is not yet in Debian.
 
-Running doctests
-================
-
-One can run the tests using the installed sage packages. First, get the source
-code for this package (`apt-get source sagemath`), and make sure the Debian
-patches are applied. Then, from any directory:
-
- *$ export -n SAGE_LOCAL SAGE_ROOT
- *$ SAGE_SRC=/path/to/sage/src sage -tp --long --logfile=ptestlong.log --all
-
-See https://www.sagemath.org/git-developer-guide/doctesting.html for more
-information and helpful tips.
-
-Feel free to upload your test logs somewhere and send links to them to our
-mailing list <debian-science-sagemath at lists.alioth.debian.org>. Please do not
-send your test logs directly, unless they are small (<400KB). Compressing them
-would be a good idea, if that helps to bring the size down.
-
-If you wish to help debug and fix test failures, see debian/README.source in
-the source package for more guidance on how to do that. In particular, you will
-need to build the source from scratch first.
-
 Known issues
 ============
 
@@ -59,5 +37,25 @@ ImportError                               Traceback (most recent call last)
 ImportError: No module named conf
 
 - SageNB doesn't load some stuff - see browser console
+  ^ should be fixed since our latest updates. Needs more testing though.
 
 - Jupyter doesn't load some stuff - see browser console
+
+Running doctests
+================
+
+One can run the tests using the installed sage packages. First, get the source
+code for this package (`apt-get source sagemath`), and make sure the Debian
+patches are applied. Then, from any directory:
+
+ *$ export -n SAGE_LOCAL SAGE_ROOT
+ *$ SAGE_SRC=/path/to/sage/src sage -tp --long --logfile=ptestlong.log --all
+
+Feel free to upload your test logs somewhere and send links to them to our
+mailing list <debian-science-sagemath at lists.alioth.debian.org>. Please do not
+send your test logs directly, unless they are small (<400KB). Compressing them
+would be a good idea, if that helps to bring the size down.
+
+If you wish to help debug and fix test failures, see debian/README.source in
+the source package for more guidance on how to do that. In particular, you will
+need to build the source from scratch first.
diff --git a/debian/README.source b/debian/README.source
index b29bd18..cf0143e 100644
--- a/debian/README.source
+++ b/debian/README.source
@@ -44,6 +44,9 @@ If doing this after `dh_auto_install` has succeeded (this is the case if you
 got some resulting .debs), then either change debian/build to debian/tmp in the
 above commands, or symlink the latter to the former.
 
+See https://www.sagemath.org/git-developer-guide/doctesting.html for more
+information and helpful tips.
+
 Debugging test failures
 =======================
 
@@ -98,11 +101,11 @@ There are three cases:
   $ DEB_BUILD_OPTIONS=nodoc debian/rules build
   
   This *should* only build the changed files. However we explicitly avoid
-  rebuilding the documentation, because incremental docbuild is broken
-  currently in upstream (#21612).
+  rebuilding the documentation, because incremental docbuild is currently
+  broken in upstream (#21612).
   
   If you are impatient, you can even cancel the build early using Ctrl-C -
-  after it copies .so files into debian/build - then running your test again.
+  after it copies .so files into debian/build - then run your test again.
 
 You may also find this useful:
 
@@ -126,7 +129,7 @@ results, please add your experience to the below summary.
 
 First, patch your local system:
 
-# fix 2 tests
+# fix 2 tests, see #840621
 sudo sed -e '/^class AppliedUndef/,${/def _sage_/,/^\s*$/d}' \
   -i /usr/lib/python2.7/dist-packages/sympy/core/function.py
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/sagemath.git