aboutsummaryrefslogtreecommitdiffstats
path: root/doc/using
Commit message (Collapse)AuthorAgeFilesLines
* update doc (synth, overview, generics, etc.) (#1205)umarcor2020-04-104-34/+80
| | | | | | | | | | | | | * doc: extend info about setting generics through the CLI * doc: rename 'Command Reference' to 'Additional Command Reference' * doc: use '``' instead of ':samp:' * doc: update info about synthesis * doc: add references to sources in internals/Overview * doc: add diagram to internals/Overview
* doc: update tips/hints related to VHPIDIRECT (#1202)umarcor2020-04-093-36/+57
|
* Update Foreign.rst to reflect my learnings (#1195)RocketRoss2020-04-082-2/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update Foreign.rst to reflect my learnings I found the page to be a little unclear in when and why to link to externally generated object files. It is a simple point in hindsight, but moving Linking foreign object files to GHDL to right after Foreign Declarations of Function makes it easier to see the link. I also added a Hint on how to pass command line arguments to ghdl_main, and wrote that the one code block is Python code (which wasn't immediately obvious to me at least). * Update Foreign.rst to reflect my learnings: Rev1 Move Linking... back to original spot. Better hint, and extra reference to simulation options. * Add reference-able label to --elab-run * Update Foreign.rst to reflect my learnings: Rev2 Clean up reference hint. * Update Foreign.rst to reflect my learnings: Rev3 Further clean reference hints. * Update Foreign.rst to reflect my learnings: Rev4 Improve hints. * Move and make -Wl,*.o hint generic, reference it * Do lables require an empty line to follow?? * Missed 'is' * Remove promise for example. * Remove promise again..... * Give up on referencing hint, just ref "linking... * Line feed reverted to LF Co-authored-by: Ross <radonnachie@gmail.com>
* vhdl-errors: give an hint for -frelaxed. Fix #1152Tristan Gingold2020-03-061-0/+1
|
* vhdl: merge synopsys into the ieee libraries. For #980Tristan Gingold2020-03-041-7/+14
|
* Add an example for the -g option. Fix #1150Tristan Gingold2020-03-031-0/+4
|
* doc: document --synth command.Tristan Gingold2020-03-021-0/+29
|
* Remove --ieee=mentor and build of mentor libraries.Tristan Gingold2020-03-021-7/+9
|
* doc: add 'GSOC Ideas' (#1093)eine2020-01-141-1/+2
|
* doc: add '.. program:: ghdl' directive (#1017)1138-4EB2019-11-126-1/+7
|
* Update doc (#1003)1138-4EB2019-11-116-380/+687
| | | | | | | | | | | | | | | | | | | | | | | | * doc: update makefile and build scripts * actions: add workflow 'doc' * doc: reorganize sections * doc: fix 'unknown option' warnings, headings, spaces, etc. * doc: add subdir 'examples', move 'quick_start' sources * doc: add section 'Development/Debugging' * doc: add section'Development/Synthesis' * doc: update roadmap * doc: add section examples * doc: use standard domain * doc: add comment about 'vhd' vs 'vhdl'
* enhance documentation terminology: reduce name clashing for VHDL standard ↵Arcturus2019-09-182-7/+7
| | | | | | | | | | | | and collections. (#925) * enhance documentation terminology: reduce name clashing for VHDL standard and collections. * lists don't have columns * apply suggestions from review * remove build artifact
* Fix some issues with the docs (#857)1138-4EB2019-06-251-2/+2
| | | | | | * fix: minor doc issues * fix: doc/helpers.py
* update(doc)1138-4EB2019-04-303-7/+357
| | | | | | | | | | * announce v0.36 * add hint about --synth and ghdlsynth * add option -gGENERIC=VALUE * add hint about --list-link * add hint about --bind * move 'Interfacing to other language' to it's own section * fix shields not being shown in contribute nor in licenses
* Document warnings enabled by default.Tristan Gingold2019-01-051-0/+5
| | | | Close #728
* doc: fix quickstart examples.Tristan Gingold2018-12-181-4/+9
|
* doc: more tips in quick start guide.Tristan Gingold2018-12-131-0/+26
| | | | Close #605
* Improve help and doc for --max-stack-alloc.Tristan Gingold2018-12-031-1/+1
|
* Add --max-stack-alloc option, check stack allocation of complex object.Tristan Gingold2018-11-231-0/+5
| | | | Fix #692
* Improve doc, fix English typo.Tristan Gingold2018-09-231-19/+49
|
* Document default stop-delta value.Tristan Gingold2018-09-161-1/+2
| | | | Fix #654
* Fix typogritbub2018-06-051-1/+1
| | | | | | | @gwtnb opened PR 597 while PR 591 was still open, pointing out this typo that had been missed. Incorporate this typo fix into PR 591
* Reduce after-sentence spacing to one spacegritbub2018-06-053-48/+48
| | | | | | | | | During PR 591 it was decided that all sentences should be ended with a period and then followed by only one space. Regex changed 132 instances of two spaces to one space (in 7 files). Also changed the second paragraph of CodingStyle to dictate the use of one space instead of two.
* Remove single quotes around linksgritbub2018-06-043-14/+14
|
* Standardize indentation to 2 spacesgritbub2018-06-042-180/+180
| | | | | Change indentation within documentation code blocks to 2 space indents instead of 3.
* Rephrase documentation - typos, grammatical nuance, and linksgritbub2018-06-013-209/+208
|
* Fixed indentation in list of supported types for the VCD format.Patrick Lehmann2018-02-101-10/+6
|
* clean todos1138-4EB2017-12-1046-3515/+32
|
* doc/changelog renamed to doc/appendix1138-4EB2017-12-103-111/+121
| | | | Replace :samp: with
* Fixed typos, indentation and headline underlining.Patrick Lehmann2017-12-103-173/+186
|
* Add raw sources of tutorial 'How to simulate an UART VHDL code with ghdl}' ↵1138-4EB2017-12-1044-2/+3510
| | | | by 'René Doß'
* Remove duplicated option1138-4EB2017-12-101-8/+2
|
* Describe commands as options. Fix internal refs to options. Apply1138-4EB2017-12-103-259/+217
| | | | | suggestions about ch 2. Add options given by the executable but not documented earlier.
* Files in the root not capitalized.1138-4EB2017-12-103-875/+265
| | | | | | | Second chapter ready for first review: Invoking reordered, some content moved to Command Reference, information compacted, command shortcuts added to titles. Known features which are missing in the doc added to TODOs or to Roadmap. Add export subsections to Using/Simulation Directory structure described in Building
* Remove scrollbar in small screens1138-4EB2017-12-101-37/+7
| | | | | Fix gitter shield link Fix first example of QuickStartGuide
* Add theme_overrrides.css1138-4EB2017-12-101-32/+11
| | | | | | Move WhatIs* to About. Move About, Contributing and Copying to doc. Rename Copying to License. Append CC-BY-SA-4.0 legalcode to COPYING.md Chapter Introduction ready for review. Starting to rewrite Building
* README.md, index, WhatIsVHDL, WhatIsGHDL ready for review.1138-4EB2017-12-101-1/+7
| | | | | | Add shortcuts for shields in a single file and include it where used. Create base64 GitHub and Travis-CI logos with b64.io and add them to self-created shields. Replace gitter with shield.io's variant. Start rewriting <Contributing>
* Allow markdown1138-4EB2017-12-101-0/+1
| | | | | | Last files from oldmds removed. All the content is in the new structure now. COPYING replaced with the md version. Update NEWS.md
* Add dots to TODOs1138-4EB2017-12-101-16/+0
|
* Removed numbers from folder names.1138-4EB2017-12-103-0/+1932
generated by cgit v1.2.3 (git 2.25.1) at 2024-08-26 10:41:36 +0000