Commit Graph

30 Commits

Author SHA1 Message Date
Jean-Paul Chaput dda3f99fd8 Update documentation for compliance with doxygen 1.8.5.
When upgrading from doxygen 1.5.x to 1.8.5 the way the documentation
is generated has underwent many changes, particularly in the headers.
* Change: In <header.html>, must include the javascripts <jquery.js>
    and <dynsections.js>.
* In <CMakeLists.txt>, as the header is customized, doxygen seems not
    copy some files like the javascripts and some images (open.png,
    closed.png). So we copy them from doxygen installation and make
    the CMakeLists.txt install them. I hope they will not change too
    much in the future.
* In <doxyfile>, disable markdown support as it do not interpret
    correctly the formating we already adopted (with a left margin
    to put command into). Use HTML_EXTRA_STYLESHEET instead of
    HTML_STYLESHEET. Enable the index (DISABLE_INDEX=NO), for the
    top header. Enable dot for inheritance diagram. Set the
    EXAMPLE_PATH=. to include the synthetic hierarchy.
    Correct the tag inclusion (faulty path in some places).
* In <SoC.css>, create style for the new header generated by doxygen.
* In the documentation, move the synthetic hierarchy into a module.
2014-05-13 16:30:41 +02:00
Jean-Paul Chaput 14a5f5f7ef Documentation restructuration
Documentation restructuration:
* Bug: in <hurricane>: bad figure for transf-R1.
* Change, in <kite>: Remove deprecated configuration variables.
* New: documentation <tool> to regroup all documentation not directly
  related to one tool.
* Change, in <crlcore>, move the user's guide and the top doc index
  into <documentation>.
* New, in <documenation>: added Python script demo based on AM2901.
2014-03-11 12:21:31 +01:00
Jean-Paul Chaput b4887b1180 * ./hurricane/doc/hurricane:
- Change: In Cell, added doc about PlacementStatus.
    - Change: In Transformation, more detailed explanations about the
        orientations. A little beautifying too...
    - Change: RoutingPad doc update.
    - Change: Entity doc update (for id).
    - Change: In HTML header/footer uses the new SoC.css.

  * ./crlcore/src:
    - Change: In DefDriver, added support for placement exportation.
    - New: In Utility, added a "paranoid" output stream (for my extra
       warnings in the router).
    - Bug: In ApParser, correct parsing of connectors index (recreate
       the vector).
    - Change: In alliance.conf, make "blockageNet" case insensitive.
    - Change: In misc.conf, added support for paranoid stream.
    - Change: In x2y and CyclopMain correct verbose flags positionning.

  * ./crlcore/doc:
    - Change: Updated style and added some documenation.
2013-12-04 01:47:34 +00:00
Jean-Paul Chaput 08b7e3971f * ./crlcore:
- Bug: In Histogram::addSample(), reject the sample if iset is superior
        OR EQUAL to the sets size...
    - Change: In etc/mauka.conf, sets "mauka.standardAnnealing" to True. Otherwise,
        when hMetis (4-part) is not used, this leads toward very poor placements.
    - New: In UsersGuide, add a third style variant for the soc-extras site.
2012-12-09 11:18:07 +00:00
Jean-Paul Chaput 266906798b * ./crlcore/doc:
- Change: README in LaTeX+LaTeX2HTML is now replaced by User's Guide
        in reStructuredText. No need to request LaTeX.
2012-12-03 14:51:44 +00:00
Jean-Paul Chaput 7448b4daed Updated documentation. 2012-12-03 12:31:41 +00:00
Jean-Paul Chaput 2012f14acf * All Tools:
- New: Added FreeBSD/Ubuntu patches from Otacilio De Araujo
       (<otaciliodearaujo@gmail.com>).

  * ./crlcore:
    - New: In Utilities, cbug stream to separate all the scary messages
        from Kite/Katabatic and maybe others.
    - New: In stratus1.conf, adds default settings previously in st_config.
    - New: Moves Python configuration helpers from under /etc/coriolis2
        into PYTHON_SITE_PACKAGES/crlcore. Adapt Utilities so coriolisInit.py
        is now searched in that directory. This way only true configuration
        files remains under /etc/coriolis2
    - Change: In helpers/__init__.py, do not try to guess the sysConfDir
        when not run through coriolisInit.py. This is done by exploring the
        call stack with traceback.
    - Change: In ApDriver, when a physical view is driven, update the flag
        in the catalog state telling that this view is present. This is far
        from satisfactory as this flag should be set as soon as any physical
        component is created.
2012-12-03 08:27:41 +00:00
Jean-Paul Chaput c87d59256d * All Tools:
- A complete sweep of cleanup to suppress allmost all compiler warnings.

  * ./crlcore:
    - New: Extented Python support for all objects needed to configure Coriolis.
    - New: Configuration files and load helpers completly written in Python.
        An XML emulation mode is still avalaible.
    - New: UsersGuide, as a replacement for README, written in ReST.
    - New: Start of Doxygen documentation (mostly for documenting the initialisation
        objects & methods).
2012-11-16 12:49:47 +00:00
Jean-Paul Chaput e2f77eb7ee * ./crlcore:
- New: In README, partial documentation update.
2011-04-12 21:42:26 +00:00
Jean-Paul Chaput ef4d088f60 Copy the genral HTML index in the right place for the
relative links to work.
2011-02-03 10:12:02 +00:00
Jean-Paul Chaput 9d970ed03d * ./crlcore:
- New: Install a general index for the HTML documentation.
    - Bug: In cyclop CMakeLists, forgot to list all the needed libraries for
        the linker.
    - New: Support of Python installation layout under Ubuntu 10.04.
        lib/python2.6/dist-packages
2011-02-02 11:17:46 +00:00
Jean-Manuel Caba dd47776631 forgot those files ... 2010-08-13 14:03:53 +00:00
Jean-Manuel Caba 71aae62f39 doxygen doc for crlcore ... 2010-08-13 02:01:18 +00:00
Jean-Paul Chaput 6990f03bec * ./crlcore:
- Change: In README, last adjustements for release 1475. They belongs to this
        release even if they are tagged 1476.
2010-06-02 15:52:45 +00:00
Jean-Paul Chaput 3401f78d35 * ./crlcore:
- Change: Rename doc files that differs only by the case, to comply with OSX.
    - Packaging: Fourth try, svn 1475.
2010-06-02 09:46:22 +00:00
Damien Dupuis 352650932e Same temporary patch for key_s.fig and key_s.png 2010-06-02 08:15:32 +00:00
Damien Dupuis d97ef75d06 Finally found what prevent me to update / checkout crlcore on mac osx :
DO NOT name two files with the same name with only case difference !
    Mac osx is by default formated as NON case sensitive system file.

    key_k.fig becomes key_k_.fig
    key_k.png becomes key_k_.png

    key_K.fig and key_K.png are not modified

    IMPORTANT: this is a temporary update to allow me to finally checkout crlcore but need to be corrected by the author
2010-06-02 08:13:22 +00:00
Jean-Paul Chaput a11088b292 * ./crlcore:
- Change: Makes all e-mail references to points to <alliance-users@asim.lip6.fr>.
    - Packaging: Third try, svn 1472.
2010-06-01 21:36:12 +00:00
Jean-Paul Chaput 4f0803096b * ./crlcore:
- Change: In Banner, use a wider cartouche.
    - Change: In README, small adjustments.
    - Packaging: Second try, svn 1470.
2010-06-01 12:15:23 +00:00
Jean-Paul Chaput 40ab589962 die die cmake die die. 2010-05-31 14:22:18 +00:00
Jean-Paul Chaput 92d134e0cb Die cmake die. 2010-05-31 14:15:37 +00:00
Jean-Paul Chaput 647a59ca3d One less FILE(COPY) ... 2010-05-31 14:09:56 +00:00
Jean-Paul Chaput 026a2ac679 * ./hurricane:
- Change: When static linking is required, also switch Boost libraries in static
        mode. Automatically done is modules using FindHURRICANE through
        SET_LIB_LINK_MODE(). Note: FindBoost must be called *after* SET_LIB_LINK_MODE().
2010-05-31 12:28:22 +00:00
Jean-Paul Chaput 3fe20ba62a The good published revision numer: try 1456 2010-05-29 14:11:42 +00:00
Jean-Paul Chaput 34d150ebd3 * ./crlcore:
- Change: In the to CMakeLists.txt checks for CMake version to see what policy
        to apply.
2010-05-29 14:08:01 +00:00
Jean-Paul Chaput 2e287fb3b4 Include the Flute license reference. 2010-05-27 11:37:16 +00:00
Jean-Paul Chaput 5d54aac81f Support for LaTeX2HTML translator. 2010-05-26 22:13:22 +00:00
Jean-Paul Chaput 740b6354d8 * ./crlcore:
- Change: In top CMakeLists.txt, prepend ${DESTDIR} to CMAKE_MODULE_PATH
        components (for use by packagers).
2010-05-22 13:46:35 +00:00
Damien Dupuis 53af1cbf49 Minor english correction 2010-05-21 21:35:45 +00:00
Jean-Paul Chaput 54b3b6fc1f * ./crlcore:
- New: Adds a README.tex describing the essentials features of Coriolis2.
    - New: Support for LaTeX in CMake through the macros supplieds by Sandia.
    - Change: Adds support for installation of config file in system-wide
        /etc.
2010-05-21 16:54:41 +00:00