summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
...
* Explain how to check the Users' guide with different paper sizes.schnetter2005-09-10
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4125 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Fix example on how to specify fortran module build dependencies (B7.2.1).tradke2005-09-09
| | | | | | | '$(SYS_OBJD)' must be omitted. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4124 17b73243-c579-4c4c-a9d2-2d5706c11dac
* tiny wording tweak to previous commitjthorn2005-09-06
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4123 17b73243-c579-4c4c-a9d2-2d5706c11dac
* [[new text mostly by Jonathan, worked out in conjunction with Thomas]]jthorn2005-09-06
| | | | | | | | | | | | | | | | | section E2.3.2 "Parameter object specification items": completely rewrite the description of INT parameters to (a) be unambiguous (b) agree with what the code seems to do (lib/sbin/parameter_parser.pl, near line 381), and hopefully (c) be easy to understand also change some surrounding text to consistently use \var{<name with multiple words>} for metavariables; previously the text had sometimes used that form and sometimes used \var{<name\_with\_multiple\_words>} for metavariables; git-svn-id: http://svn.cactuscode.org/flesh/trunk@4122 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Correct error in explanation of cctk_origin_space.schnetter2005-08-21
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4111 17b73243-c579-4c4c-a9d2-2d5706c11dac
* typo fixrideout2005-08-10
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4108 17b73243-c579-4c4c-a9d2-2d5706c11dac
* a bit more explanation about error codes for CCTK_InterpGridArraysjthorn2005-08-02
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4100 17b73243-c579-4c4c-a9d2-2d5706c11dac
* CCTK_InterpGridArrays()jthorn2005-08-02
| | | | | | | | | Discussion section += a paragraph explaining that the returned result is always the same on all processors, and how current implementations compute this (global minimum over all processors) git-svn-id: http://svn.cactuscode.org/flesh/trunk@4099 17b73243-c579-4c4c-a9d2-2d5706c11dac
* clarify that Boolean literals may *optionally* be enclosed in double quotesjthorn2005-07-29
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4098 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Chapter on Key/Value Tables:jthorn2005-07-12
| | | | | | | | clarify wording of footnote warning about the inefficency of storing large arrays in tables git-svn-id: http://svn.cactuscode.org/flesh/trunk@4089 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Util_TableSet*Array() and Util_TableSetGenericArray()jthorn2005-07-12
| | | | | | | += warning about the inefficiency of storing large arrays in a table git-svn-id: http://svn.cactuscode.org/flesh/trunk@4088 17b73243-c579-4c4c-a9d2-2d5706c11dac
* CCTK_Equals() descriptionjthorn2005-07-04
| | | | | | | | | * rewrite in new FunctionDescription environment * clarify that it returns 1 for equal, 0 for not equal * add examples git-svn-id: http://svn.cactuscode.org/flesh/trunk@4087 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Warn against using the configure variables LDFLAGS and LIBS.schnetter2005-07-03
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4086 17b73243-c579-4c4c-a9d2-2d5706c11dac
* add amsmath package as perjthorn2005-06-24
| | | | | | | | <http://www.cactuscode.org/pipermail/developers/2005-June/001071.html> and following discussion git-svn-id: http://svn.cactuscode.org/flesh/trunk@4085 17b73243-c579-4c4c-a9d2-2d5706c11dac
* correct default cctk_full_warnings description for CCTK_VWarn()jthorn2005-06-22
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4084 17b73243-c579-4c4c-a9d2-2d5706c11dac
* fix latex formatting of previous commitjthorn2005-06-22
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4083 17b73243-c579-4c4c-a9d2-2d5706c11dac
* fix description of return value for internal fn CCTK_Warn()jthorn2005-06-22
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4082 17b73243-c579-4c4c-a9d2-2d5706c11dac
* document why it's good that CCTK_VWarn() returns an int, ratherjthorn2005-06-22
| | | | | | | | than having it be of type void (this allows it to be used in a C conditional expression) git-svn-id: http://svn.cactuscode.org/flesh/trunk@4081 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Update keyword parameter description wrt. enclosing them in quotes;schnetter2005-06-03
| | | | | | | change from "may" to "should". git-svn-id: http://svn.cactuscode.org/flesh/trunk@4070 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Fixed documentation for CCTK_ReduceGridArrays().tradke2005-06-03
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4068 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Reduce text height from 24 cm to 22 cm. Letter paper is not bigschnetter2005-06-02
| | | | | | | | | | enough to hold 24 cm of text. This closes PR 1912. Yes, this is indeed "letter paper is not big enough to hold 24 cm of text", although 1912 was about A4 paper. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4066 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Describe where double quotes are necessary for boolean, string, andschnetter2005-05-27
| | | | | | | keyword parameters. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4064 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Create ThornGuide.pdf from ThornGuide.dvi by running dvipdf on it.tradke2005-05-26
| | | | | | | | | | This fixes problems with embedded images which are available only as EPS and thus couldn't be processed by pdflatex. This closes PR Documentation/1937: "make ThornGuide.pdf fails". git-svn-id: http://svn.cactuscode.org/flesh/trunk@4062 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Effects a fix for PR 1343 and a partial fix for PR 989swhite2005-05-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This was discussed on CactusMaint Wed, 27 Apr 2005 as Patch for PR 1913: ThornGuide and Latex errors (Note the 1913 seems to be a typo--it should have been 1343) Files changed: Makefile, doc/ThornGuide/Makefile Affects targets: ThornGuide, ThornGuide.pdf, <config>-ThornGuide UsersGuide, ReferenceManual, MaintGuide Main purpose: To give the user a sensible error message in case something goes wrong with latex'ing, pointing them to the appropriate latex log files, and stopping the build. Also, made on-screen messages a little clearer as to what is going on. Since the patch was posted, these additions were suggested and implemented. * Instead of copying the ps files to the doc directory, they are now moved (more efficient) * If ThornList is missing, make <config>-ThornGuide now complains. * Now also greps for LaTeX Warning, and complains if it finds one. Tested: Ran all targets on functioning CCL files, and on one with bad embedded LaTeX (a missing right-curley-bracket will do it). To Do: 1) make ThornGuide.pdf still doesn't work because pdflatex doesn't take eps files. Would ps2pdf be a suitable alternative? (PR 1937) 2) Erik and Jonathan would both like to see all latex warnings about preferences worked out. 3) Scripts that parse the CCL files still fail silently, resulting in incomplete documentation. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4061 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Fixed typo: "Synopsos" -> "Synopsis".tradke2005-05-24
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4059 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Reformat the latex source of the section about param.ccl to make itschnetter2005-05-15
| | | | | | | | | | | | more readable. Suggest the regular expression "" instead of ".*" to match any string. State that CCTK_REAL4 etc. are not allowed parameter types. This was wrong before. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4051 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Describe CCTK_FortranString according to my suggestion on theschnetter2005-05-08
| | | | | | | | | developers' mailing list. Add a description of the C API as well. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4043 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Some updates to the description of CCTK_FortranString:schnetter2005-05-07
| | | | | | | | | | Correct and simplify declaration Reorder parameters in the explanation to match the calling order Mention error code Simplify example git-svn-id: http://svn.cactuscode.org/flesh/trunk@4042 17b73243-c579-4c4c-a9d2-2d5706c11dac
* fix table-of-contents 1-line summary of CCTK_FortranString()jthorn2005-05-07
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4041 17b73243-c579-4c4c-a9d2-2d5706c11dac
* redo description of CCTK_FortranString():jthorn2005-05-07
| | | | | | | | | | | * convert from old CCTKFunc latex environment to new FunctionDescription latex environment * add an example * clarify that string_length argument is an *output* from this function * other wording clarifications git-svn-id: http://svn.cactuscode.org/flesh/trunk@4040 17b73243-c579-4c4c-a9d2-2d5706c11dac
* convert description of CCTK_IsThornActive()jthorn2005-05-05
| | | | | | | | | from old CCTKFunc latex environment to new FunctionDescription latex environment, since the formatting was a bit ugly in the old format git-svn-id: http://svn.cactuscode.org/flesh/trunk@4039 17b73243-c579-4c4c-a9d2-2d5706c11dac
* * document both syntaxes for scheduling something before/after any/alljthorn2005-04-22
| | | | | | | | | | of a set of other things (previously neither syntax was documented) (Tom confirmed that both syntaxes are valid in an E-mail to developers@cactuscode.org on 16.Nov.2004) * point to Users' Guide for further explanation git-svn-id: http://svn.cactuscode.org/flesh/trunk@4034 17b73243-c579-4c4c-a9d2-2d5706c11dac
* clarify wording on BEFORE/AFTER schedule clauses,jthorn2005-04-22
| | | | | | | | | add explicit statement that cyclic dependencies are verboten -- thanks to Steve for helping me come up with better wording git-svn-id: http://svn.cactuscode.org/flesh/trunk@4033 17b73243-c579-4c4c-a9d2-2d5706c11dac
* document both syntaxes for scheduling something before/after any/alljthorn2005-04-22
| | | | | | | | | of a set of other things (previously neither syntax was documented) (Tom confirmed that both syntaxes are valid in an E-mail to developers@cactuscode.org on 16.Nov.2004) git-svn-id: http://svn.cactuscode.org/flesh/trunk@4032 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Explained that the result of CCTK_VarName should not beswhite2005-04-21
| | | | | | | freed after use. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4031 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Put CCTK_L* entries in correct alphabetical order.swhite2005-04-21
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4030 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Document CCTK_TerminateNext().tradke2005-04-19
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4029 17b73243-c579-4c4c-a9d2-2d5706c11dac
* clarify that an aliased function may have a CCTK_POINTER ARRAY argument,jthorn2005-04-11
| | | | | | | but *not* CCTK_STRING ARRAY or CCTK_FPOINTER ARRAY. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4026 17b73243-c579-4c4c-a9d2-2d5706c11dac
* comment out an accidentally-not-commented-out line which showedjthorn2005-04-11
| | | | | | | | | | up as spurious text at the bottom of the CCTK_InterpHandle() page [the commented-out text is part of a description of an envisioned CCTK_InterpLocalNonUniform() which is not implemented yet] git-svn-id: http://svn.cactuscode.org/flesh/trunk@4025 17b73243-c579-4c4c-a9d2-2d5706c11dac
* fix Util_snprintf() examples to actually use Util_snprintf()jthorn2005-04-07
| | | | | | | -- previously they used snprintf() git-svn-id: http://svn.cactuscode.org/flesh/trunk@4022 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Fix wrong order of arguments in CCTK_FortranString().tradke2005-04-01
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4019 17b73243-c579-4c4c-a9d2-2d5706c11dac
* key/value table iterators (Util_TableIt*() functions):jthorn2005-03-18
| | | | | | | * standardize terminology that ihandle is "handle to table iterator" git-svn-id: http://svn.cactuscode.org/flesh/trunk@4015 17b73243-c579-4c4c-a9d2-2d5706c11dac
* document that Util_TableSetGeneric() and SetGenericArray()jthorn2005-03-18
| | | | | | | may return UTIL_ERROR_BAD_INPUT for invalid type_code git-svn-id: http://svn.cactuscode.org/flesh/trunk@4009 17b73243-c579-4c4c-a9d2-2d5706c11dac
* CCTK_VarTypeSize() entryjthorn2005-03-18
| | | | | | | | | * add -1 error return * add Fortran prototype * clarify wording in description git-svn-id: http://svn.cactuscode.org/flesh/trunk@4007 17b73243-c579-4c4c-a9d2-2d5706c11dac
* typo fix for Util_TableGetXxx() entryjthorn2005-03-17
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4005 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Util_Table{Get,Set}Xxx() entriesjthorn2005-03-17
| | | | | | | | | | | * add CCTK_BYTE to *all* the entries (I forgot some before :) * tweak wording on what data types Fortran supports Util_Table{Get,Set}XxxArray() entries * document that Fortran accepts the same data types as C git-svn-id: http://svn.cactuscode.org/flesh/trunk@4004 17b73243-c579-4c4c-a9d2-2d5706c11dac
* section B10.8 "Data Types and Sizes" (page B67)schnetter2005-03-17
| | | | | | | * remove CCTK_CHAR from table listing all the Cactus data types git-svn-id: http://svn.cactuscode.org/flesh/trunk@4003 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Util_Table{Get,Set}Xxx() entriesjthorn2005-03-17
| | | | | | | | | | | | * add CCTK_BYTE * document that CCTK_CHAR isn't available from Fortran s/Util_TableGet*String()/Util_TableGetString() (no such function ever existed, so I suspect this was a global-search-and-replace typo sometime in the past) git-svn-id: http://svn.cactuscode.org/flesh/trunk@4002 17b73243-c579-4c4c-a9d2-2d5706c11dac
* section B10.8 "Data Types and Sizes" (page B67)jthorn2005-03-17
| | | | | | | * add CCTK_BYTE to table listing all the Cactus data types git-svn-id: http://svn.cactuscode.org/flesh/trunk@4001 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Renamed README.NT to README.Windows.goodale2005-02-10
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@3985 17b73243-c579-4c4c-a9d2-2d5706c11dac
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-10 19:35:02 +0000