#4370: Add ability to clone the doc repository
---------------------------+------------------------------------------------
Reporter: cremona | Owner: tba
Type: enhancement | Status: new
Priority: major | Milestone: sage-3.2
Component: documentation | Keywords:
---------------------------+------------------------------------------------
It would be very useful to be able to clone the documentation repository
as well as the source repo. As Minh Van Nguyen said:
{{{
Is there a corresponding command or process that I can use to clone the
doc-main repo as well?
Whenever I review the official documentation that's shipped with each
Sage release, I would go into
<sage-home>/devel/doc-main
and then review the documentation from there. If I'm reviewing someone's
patch to any file in the latter directory, I would not clone doc-main
(since I don't yet know how to do that). Instead, I would go ahead with
applying the patch and then do more review of the patch. At this point,
at least one of two things can happen:
[1] If the patch gets a positive review, then all is fine and good.
[2] However, in case there's something wrong with the patched file and I
want to un-apply the patch, I would do this:
sage: hg_doc.revert()
This command reverts back to the stage at which the file in question is
unpatched.
Another possibility is for me to copy a source distro to more than one
directory, and then build (and test) the distro from those different
directories. That way, I would have a copy of Sage that I can use and
with which I won't apply any documentation patches. And I would also
have another copy of Sage for applying documentation patches. Building
one copy of a source distro usually takes a _very_ long time on each
machine that I have access to --- and running all standard tests further
add to my waiting time. As you can imagine, repeating the build and test
processes on the same machine for another copy of the same source distro
would further add to the waiting time. (Man, I can't wait to work on
Sage ;-)
}}}
and as mabshoff replied:
{{{
it is fairly simple to add a clone command for the doc repo. If you
want it just open a ticket and someone will take care of it. You can
even try yourself - just look at local/bin/sage-clone and ignore
nearly everything toward the end since that deals with build file
issues.
}}}
I think this will encourage people to add / improce the existing docs and
to review enhancements of the docs.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/4370>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en
-~----------~----~----~----~------~----~------~--~---
