Opened 11 years ago

Closed 11 years ago

#8242 closed defect (fixed)

Fix duplicate citation warnings when building the French-language tutorial

Reported by: mpatel Owned by: mmezzarobba
Priority: minor Milestone: sage-4.4
Component: documentation Keywords:
Cc: Merged in: sage-4.4.alpha0
Authors: Marc Mezzarobba Reviewers: Paul Zimmermann, Minh Van Nguyen
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

Ticket #7772 resolves these for the English-language tutorial.

bibliography.rst:27: WARNING: duplicate citation Py, other instance in afterword.rst
bibliography.rst:30: WARNING: duplicate citation PyDev, other instance in afterword.rst
interactive_shell.rst:974: WARNING: duplicate citation Py, other instance in bibliography.rst
interfaces.rst:357: WARNING: duplicate citation GAPkg, other instance in bibliography.rst
introduction.rst:155: WARNING: duplicate citation Dive, other instance in bibliography.rst
introduction.rst:158: WARNING: duplicate citation PyT, other instance in bibliography.rst
programming.rst:880: WARNING: duplicate citation PyT, other instance in introduction.rst
tour_algebra.rst:395: WARNING: duplicate citation GAP, other instance in bibliography.rst
tour_algebra.rst:397: WARNING: duplicate citation Max, other instance in bibliography.rst
tour_plotting.rst:187: WARNING: duplicate citation Jmol, other instance in bibliography.rst
tour_polynomial.rst:340: WARNING: duplicate citation Si, other instance in bibliography.rst

Attachments (3)

trac_8242_duplicate_citations.patch (8.7 KB) - added by mmezzarobba 11 years ago.
trac_8242-citations-rebased.patch (7.8 KB) - added by mvngu 11 years ago.
rebased vs. Sage 4.3.4.alpha1
trac_8242-reviewer.patch (2.7 KB) - added by mvngu 11 years ago.
apply on top of previous

Download all attachments as: .zip

Change History (15)

comment:1 Changed 11 years ago by mmezzarobba

  • Owner changed from mvngu to mmezzarobba

Changed 11 years ago by mmezzarobba

comment:2 Changed 11 years ago by mmezzarobba

  • Status changed from new to needs_review

comment:3 Changed 11 years ago by zimmerma

  • Reviewers set to Paul Zimmermann
  • Status changed from needs_review to needs_work

How can I review that patch (i.e., check the warning are no longer present)?

Also some typos are still present, for example Parcourrez should be Parcourez, composantes should be composants.

Paul

comment:4 Changed 11 years ago by zimmerma

The answer to my question was (thanks Marc):

sage -docbuild fr/tutorial html

However some warnings still remain...

comment:5 Changed 11 years ago by mvngu

  • Authors set to Marc Mezzarobba
  • Milestone set to sage-4.3.4
  • Reviewers changed from Paul Zimmermann to Paul Zimmermann, Minh Van Nguyen
  • Status changed from needs_work to needs_review

After applying the patch trac_8242_duplicate_citations.patch, I still received two warnings when rebuilding the HTML version of the French tutorial:

/dev/shm/mvngu/sandbox/sage-4.3.3/devel/sage/doc/fr/tutorial/programming.rst:: WARNING: citation not found: Cython
/dev/shm/mvngu/sandbox/sage-4.3.3/devel/sage/doc/fr/tutorial/programming.rst:: WARNING: citation not found: Pyrex
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 2 warnings.

The reviewer patch trac_8242-reviewer.patch fixes those two warnings and takes care of the typos reported by zimmerma. So only the reviewer patch needs some reviewing from anyone other than me. Once it gets a positive review, the whole ticket gets a positive review.

comment:6 Changed 11 years ago by zimmerma

  • Status changed from needs_review to positive_review

I just checked the reviewer patch and I get no warnings any more. Thus a positive review.

comment:7 Changed 11 years ago by mvngu

  • Status changed from positive_review to needs_work

The attachment trac_8242_duplicate_citations.patch conflicts with ticket #8037, in particular the patch trac_8037_sagetex_french_tutorial.2.patch on that ticket. Here's the hunk failure resulting from first applying #8037, followed by the first patch on #8242:

[mvngu@sage sage-main]$ pwd
/dev/shm/mvngu/sandbox/sage-4.3.3-8242/devel/sage-main
[mvngu@sage sage-main]$ hg qimport http://trac.sagemath.org/sage_trac/raw-attachment/ticket/8037/trac_8037_sagetex_french_tutorial.2.patch && hg qpush
adding trac_8037_sagetex_french_tutorial.2.patch to series file
applying trac_8037_sagetex_french_tutorial.2.patch
now at: trac_8037_sagetex_french_tutorial.2.patch
[mvngu@sage sage-main]$ hg qimport http://trac.sagemath.org/sage_trac/raw-attachment/ticket/8242/trac_8242_duplicate_citations.patch && hg qpush
adding trac_8242_duplicate_citations.patch to series file
applying trac_8242_duplicate_citations.patch
patching file doc/fr/tutorial/introduction.rst
Hunk #1 FAILED at 62
1 out of 2 hunks FAILED -- saving rejects to file doc/fr/tutorial/introduction.rst.rej
patch failed, unable to continue (try -v)
patch failed, rejects left in working dir
errors during apply, please fix and refresh trac_8242_duplicate_citations.patch
[mvngu@sage sage-main]$ cat doc/fr/tutorial/introduction.rst.rej
--- introduction.rst
+++ introduction.rst
@@ -63,7 +63,7 @@
 
 Des instructions pour installer Sage sur votre ordinateur sont
 disponibles dans le guide d'installation (*Installation Guide*), dans
-la section documentation de la page web principale de Sage [Sage]_.
+la section documentation de la page web principale de Sage [SA]_.
 Nous nous limiterons ici à deux remarques.
 
 #. La version téléchargeable de Sage vient avec ses dépendances.

On the one hand, ticket #8037 wants to make the change

- la section documentation de la page web principale de Sage [SA]_.
+ la section documentation de la page web principale de Sage [Sage]_.

But the current ticket (i.e. #8242) wants to make the change

-la section documentation de la page web principale de Sage [Sage]_.
+la section documentation de la page web principale de Sage [SA]_.

The patches on this ticket needs to be rebased on top of #8037.

comment:8 Changed 11 years ago by mvngu

  • Work issues set to rebase on top of #8037

Changed 11 years ago by mvngu

rebased vs. Sage 4.3.4.alpha1

Changed 11 years ago by mvngu

apply on top of previous

comment:9 Changed 11 years ago by mvngu

  • Status changed from needs_work to needs_review
  • Work issues rebase on top of #8037 deleted

I have rebased Marc's patch against Sage 4.3.4.alpha1. Now apply patches in this order:

  1. trac_8242-citations-rebased.patch
  2. trac_8242-reviewer.patch

Both the rebased patch and my reviewer patch need reviewing by anyone but me. If they both get a positive review, then the whole ticket is good to go into Sage 4.3.4.rc0.

comment:10 Changed 11 years ago by zimmerma

I tried to apply the new patches but got a failure for the 2nd one:

applying /tmp/trac_8242-reviewer.patch
patching file doc/fr/tutorial/introduction.rst
Hunk #1 FAILED at 64
1 out of 1 hunks FAILED -- saving rejects to file doc/fr/tutorial/introduction.rst.rej
abort: patch failed to apply

Maybe I didn't have a clean 4.3.3. Can somebody else try?

Postfix: sorry, I see the patches should be applied to 4.3.4.alpha1. Sorry, I cannot review patches based on alpha releases (not the time to compile them).

comment:11 Changed 11 years ago by mmezzarobba

  • Status changed from needs_review to positive_review

The patches apply fine on top of 4.3.4 and there are no more duplicate citations warnings.

comment:12 Changed 11 years ago by jhpalmieri

  • Merged in set to sage-4.4.alpha0
  • Resolution set to fixed
  • Status changed from positive_review to closed

Merged in 4.4.alpha0:

  • trac_8242-citations-rebased.patch
  • trac_8242-reviewer.patch
Note: See TracTickets for help on using tickets.