Manual updates #75
Manual updates #75
Conversation
tjhei
commented
May 25, 2014
tjhei
commented
- extract .prms
- add section explaining benchmark compilation
- more safe escaping in .prms
|
Okay, I think I am done now. @bangerth please merge. |
| \label{sec:benchmark-run} | ||
|
|
||
| Some of the benchmarks require plugins like custom material models, boundary | ||
| conditions, or postprocessors. Not not polute \aspect{} with all these |
|
Good work. Please merge after addressing the minor comments. I'm not too fond of the style %%...% for comments -- I think it is a bit confusing to use the same character but in different numbers to denote comment start/end. But I don't feel overly strong about it, and we can always change it later. Is it worth extending the Makefile to automatically generate the .prm.out files from the .prm files? This would make it simpler to keep things synchronized. |
|
I had to change the style and using the same symbol for beginning and end didn't work if I remember correctly. I am happy to change it to something else, but it shouldn't be visible for anyone anyway. Regarding the Makefile rule: makes sense. I will take a look. |
|
The Makefile rule is somewhat problematic because you need a deal.II version from yesterday for all of this to work. Should I remove the .prm.out from the repo anyway and generate them if you run make manual.pdf? |
|
Don't bother about the comment start/end. -------- Original message -------- I had to change the style and using the same symbol for beginning and end didn't work if I remember correctly. I am happy to change it to something else, but it shouldn't be visible for anyone anyway. Regarding the Makefile rule: makes sense. I will take a look. — |
We now auto-generate the annotated .prm.out files from the .prm files when you make manual.pdf. All prm snippets in the manual now live in external files. This patch also contains updates to the benchmark section explaining how to compile the shared libs for the benchmarks. This is a combination of 9 commits: extract more prms from manual manual: add section explaining benchmark compilation add missing .prm change to more safe escaping in .prm for manual final batch of prms extracted from the manual rename sol_cx.prm and improve manual rename sol_kz prm remove all .out and generate them on demand instead update .gitignore
|
I don't understand your comment about the deal.II version. Creating the .prm.out files from the .prm file only requires a Makefile glob and calling perl, no? What dependency on deal.II would that have? |
|
You are right. I confused it with update_parameters.sh that needs a newer deal.II version. I went ahead and implemented your suggestion (already merged). |
