how about incrementally updating

37 views
Skip to first unread message

Lei Qiao

unread,
Apr 8, 2013, 12:49:40 PM4/8/13
to dea...@googlegroups.com
To keep the release package thin, lots of pictures were pulled out and not avilable offline. Althought the tutorial in version 7.2.0 is surfficient for a very beginer like me, I still think an offline package can give this library a great portablity. And, to slow down the expantion of the package size and avoid redundant information in the neighboring versions, I suggest to introduce the incrementally updating into this project. It is an efficient manner to ensure data integrity and make users can keep their code up to date easily.
 
What do you thin about this?

Wolfgang Bangerth

unread,
Apr 8, 2013, 3:47:56 PM4/8/13
to dea...@googlegroups.com, Lei Qiao
You mean provide a patch from 7.2 to 7.3? I think such a patch would be
about the same size as the actual library...

Best
W.


--
------------------------------------------------------------------------
Wolfgang Bangerth email: bang...@math.tamu.edu
www: http://www.math.tamu.edu/~bangerth/

Matthias Maier

unread,
Apr 8, 2013, 5:25:05 PM4/8/13
to dea...@googlegroups.com

Am 08. Apr 2013, 21:47 schrieb Wolfgang Bangerth <bang...@math.tamu.edu>:

> On 04/08/2013 11:49 AM, Lei Qiao wrote:
>> To keep the release package thin, lots of pictures were pulled out and
>> not avilable offline. Althought the tutorial in version 7.2.0 is
>> surfficient for a very beginer like me, I still think an offline package
>> can give this library a great portablity. And, to slow down the
>> expantion of the package size and avoid redundant information in the
>> neighboring versions, I suggest to introduce the incrementally updating
>> into this project. It is an efficient manner to ensure data integrity
>> and make users can keep their code up to date easily.
>> What do you thin about this?
>
> You mean provide a patch from 7.2 to 7.3? I think such a patch would
> be about the same size as the actual library...

I think, the following was proposed:


- provide e.g. deal.doc-7.2.0.tar.gz with full documentation (offline
and online bits)

- let deal.doc-7.3.0.tar.gz be just the offline bits so that copying
it over the old documentation provides the full documentation for
7.3. (again offline and online bits).


This suggestion aside, this whole topic does raise one question:

How do we want to support full offline documentation in the future?

It would be very desirable to have something like:

- deal.doc-7.3.0.tar.gz providing the offline bits

and a seperate download

- deal.doc-whatever

providing the online bits of the documentation, so that just unpacking
both archives provides a fully functional offline documentation.

Best,
Matthias

Timo Heister

unread,
Apr 8, 2013, 7:09:39 PM4/8/13
to dea...@googlegroups.com
To reduce complexity I would suggest that we change deal.doc.tar.gz to
include the complete offline documentation.
> --
> The deal.II project is located at http://www.dealii.org/
> For mailing list/forum options, see https://groups.google.com/d/forum/dealii?hl=en
> ---
> You received this message because you are subscribed to the Google Groups "deal.II User Group" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to dealii+un...@googlegroups.com.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>

--
Timo Heister
http://www.math.tamu.edu/~heister/

Wolfgang Bangerth

unread,
Apr 8, 2013, 9:51:36 PM4/8/13
to dea...@googlegroups.com
On 04/08/2013 06:09 PM, Timo Heister wrote:
> To reduce complexity I would suggest that we change deal.doc.tar.gz to
> include the complete offline documentation.

Yes. We may need to adjust a few links in the doc/doxygen/deal.II directory
(from global to local) but that shouldn't be too hard. Is it worthwhile doing
this retroactively for 7.3, or should we simply put that on the list for 8.0?

Wolfgang Bangerth

unread,
Apr 9, 2013, 3:40:55 PM4/9/13
to dea...@googlegroups.com
On 04/08/2013 04:25 PM, Matthias Maier wrote:
> How do we want to support full offline documentation in the future?
>
> It would be very desirable to have something like:
>
> - deal.doc-7.3.0.tar.gz providing the offline bits
>
> and a seperate download
>
> - deal.doc-whatever
>
> providing the online bits of the documentation, so that just unpacking
> both archives provides a fully functional offline documentation.

We used to have both self-contained, i.e. usable locally without an
internet connection. Guido didn't like that idea because the tar files
became too big (a true fact). I think the best we can do is produce a
deal.doc.tar.gz that contains fixed up paths to the pictures along with
the pictures themselves.

My preferred solution would be to ignore the issue for the current
release 7.3 and do this for the upcoming 8.0. For those affected by the
problem, please download the documentation for 7.2 which contains almost
the exact same set of tutorial programs (which I believe are the only
affected parts).

乔磊

unread,
Apr 9, 2013, 9:34:08 PM4/9/13
to dea...@googlegroups.com
I agree with your solution.


2013/4/10 Wolfgang Bangerth <bang...@math.tamu.edu>
--
The deal.II project is located at http://www.dealii.org/
For mailing list/forum options, see https://groups.google.com/d/forum/dealii?hl=en
--- You received this message because you are subscribed to a topic in the Google Groups "deal.II User Group" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/dealii/w5aj43XWIxo/unsubscribe?hl=en.
To unsubscribe from this group and all its topics, send an email to dealii+unsubscribe@googlegroups.com.

For more options, visit https://groups.google.com/groups/opt_out.





--
乔磊

Timo Heister

unread,
Apr 10, 2013, 12:23:38 AM4/10/13
to dea...@googlegroups.com
I created the script contrib/utilities/makeofflinedoc.sh
If you run it in the output directory of the documentation (I am not
installing, only compiling the documentation and for me the path is
build/doc/doxygen/deal.II) it will
1. download all the .png and .gif from the website
2. patch the .html files so that the links work

This is now easy to run when packaging the -doc for release.
> --
> The deal.II project is located at http://www.dealii.org/
> For mailing list/forum options, see
> https://groups.google.com/d/forum/dealii?hl=en
> --- You received this message because you are subscribed to the Google
> Groups "deal.II User Group" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to dealii+un...@googlegroups.com.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>



--
Timo Heister
http://www.math.tamu.edu/~heister/

Timo Heister

unread,
Apr 10, 2013, 9:27:35 AM4/10/13
to dea...@googlegroups.com

Wolfgang Bangerth

unread,
Apr 10, 2013, 6:49:01 PM4/10/13
to dea...@googlegroups.com
On 04/10/2013 08:27 AM, Timo Heister wrote:
> can someone please test if
> https://code.google.com/p/dealii/downloads/detail?name=deal.offlinedoc-7.3.0.tar.gz
> works correctly?

It does here. Thanks a lot! (Can you place the instructions in
RELEASE/tasks?)

Timo Heister

unread,
Apr 10, 2013, 7:45:26 PM4/10/13
to dea...@googlegroups.com
> It does here. Thanks a lot! (Can you place the instructions in
> RELEASE/tasks?)

make_release script is adapted for the before-cmake releases and I
left a TODO in the RELEASE/tasks.
Reply all
Reply to author
Forward
0 new messages