diff --git a/.gitignore b/.gitignore index b6dc1d6d..fce9d34f 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,7 @@ TAGS GTAGS GPATH GRTAGS -dir-locals.el +.dir-locals.el .projectile diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt index a3ced41c..9dbe321d 100644 --- a/documentation/CMakeLists.txt +++ b/documentation/CMakeLists.txt @@ -22,7 +22,7 @@ if(BUILD_DOC) set ( htmlInstallDir share/doc/coriolis2/en/html/main ) set ( pdfInstallDir share/doc/coriolis2/en/pdf/main ) - + set ( pythonCppRst PythonCpp/pdfHeader.rst PythonCpp/Introduction.rst PythonCpp/Configuration.rst @@ -46,46 +46,44 @@ add_custom_target ( doc_HTML ALL cd ${DOCUMENTATION_SOURCE_DIR} && rm -rf _build - && sphinx-build -b html -d _build/doctrees . _build/html ) - add_dependencies ( doc_HTML ../etc/definitions.rst - ../_static/SoC.css - ../_static/www-SoC.css - ../_static/SoC-ReST.css - ../_static/pygments.css - CrlCore/CrlCore.rst - DpGen/DpGen.rst - Hurricane/Hurricane.rst - Patterns/Patterns.rst - Stratus/Stratus.rst - Unicorn/Unicorn.rst - Viewer/Viewer.rst - ${usersGuideRst} UsersGuide/index.rst - ${pythonCppRst} PythonCpp/index.rst - ${rdsRst} RDS/index.rst + && sphinx-build -b html -d _build/doctrees . _build/html + DEPENDS etc/definitions.rst + _static/SoC.css + _static/www-SoC.css + _static/SoC-ReST.css + _static/pygments.css + CrlCore/CrlCore.rst + DpGen/DpGen.rst + Hurricane/Hurricane.rst + Patterns/Patterns.rst + Stratus/Stratus.rst + Unicorn/Unicorn.rst + Viewer/Viewer.rst + ${usersGuideRst} UsersGuide/index.rst + ${pythonCppRst} PythonCpp/index.rst + ${rdsRst} RDS/index.rst ) add_custom_target ( pdf_UsersGuide ALL cd ${DOCUMENTATION_SOURCE_DIR}/UsersGuide - && ../etc/doPdf.sh ${usersGuideRst} UsersGuide.rst ) - add_dependencies ( pdf_UsersGuide ../etc/definitions.rst - ../etc/SoC-ReST.tex - ${usersGuideRst} ) + && ../etc/doPdf.sh ${usersGuideRst} UsersGuide.rst + DEPENDS etc/definitions.rst + etc/SoC-ReST.tex + ${usersGuideRst} ) add_custom_target ( pdf_PythonCpp ALL cd ${DOCUMENTATION_SOURCE_DIR}/PythonCpp && ../etc/doPdf.sh ${pythonCppRst} PythonCpp.rst - ) - add_dependencies ( pdf_PythonCpp ../etc/definitions.rst - ../etc/SoC-ReST.tex - ${pythonCppRst} ) + DEPENDS etc/definitions.rst + etc/SoC-ReST.tex + ${pythonCppRst} ) add_custom_target ( pdf_RDS ALL cd ${DOCUMENTATION_SOURCE_DIR}/RDS && ../etc/doPdf.sh ${rdsRst} RDS.rst - ) - add_dependencies ( pdf_RDS ../etc/definitions.rst - ../etc/SoC-ReST.tex - ${pythonCppRst} ) + DEPENDS etc/definitions.rst + etc/SoC-ReST.tex + ${pythonCppRst} ) install ( DIRECTORY _build/html/ DESTINATION ${htmlInstallDir} ) install ( FILES RDS/RDS.pdf diff --git a/documentation/PythonCpp/PythonCpp.pdf b/documentation/PythonCpp/PythonCpp.pdf index 0efe7a5f..bca263b3 100644 Binary files a/documentation/PythonCpp/PythonCpp.pdf and b/documentation/PythonCpp/PythonCpp.pdf differ diff --git a/documentation/RDS/RDS.pdf b/documentation/RDS/RDS.pdf index 607db0b0..4b6c9762 100644 Binary files a/documentation/RDS/RDS.pdf and b/documentation/RDS/RDS.pdf differ diff --git a/documentation/UsersGuide/Installation.rst b/documentation/UsersGuide/Installation.rst index 224ee5f4..1851f84c 100644 --- a/documentation/UsersGuide/Installation.rst +++ b/documentation/UsersGuide/Installation.rst @@ -103,23 +103,23 @@ First step is to install the prerequisites. Currently, only RapidJSON_. As RapidJSON is evolving fast, if you encounter compatibility problems, the exact version we compiled against is given below. :: - dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src/support - dummy@lepka:~$ cd ~/coriolis-2.x/src/support - dummy@lepka:~$ git clone http://github.com/miloyip/rapidjson - dummy@lepka:~$ git checkout ec322005072076ef53984462fb4a1075c27c7dfd + dummy@lepka:~> mkdir -p ~/coriolis-2.x/src/support + dummy@lepka:~> cd ~/coriolis-2.x/src/support + dummy@lepka:~> git clone http://github.com/miloyip/rapidjson + dummy@lepka:~> git checkout ec322005072076ef53984462fb4a1075c27c7dfd The second step is to create the source directory and pull the |git| repository: :: - dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src - dummy@lepka:~$ cd ~/coriolis-2.x/src - dummy@lepka:~$ git clone https://www-soc.lip6.fr/git/coriolis.git + dummy@lepka:~> mkdir -p ~/coriolis-2.x/src + dummy@lepka:~> cd ~/coriolis-2.x/src + dummy@lepka:~> git clone https://www-soc.lip6.fr/git/coriolis.git Third and final step, build & install: :: - dummy@lepka:src$ ./bootstrap/ccb.py --project=support \ + dummy@lepka:src> ./bootstrap/ccb.py --project=support \ --project=coriolis \ --make="-j4 install" - dummy@lepka:src$ ./bootstrap/ccb.py --project=support \ + dummy@lepka:src> ./bootstrap/ccb.py --project=support \ --project=coriolis \ --doc --make="-j1 install" @@ -129,7 +129,7 @@ stage in ``-j4`` (or whatever) then we generate the documentation in ``-j1`` Under |RHEL6| or clones, you must build using the |devtoolset2|: :: - dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \ + dummy@lepka:src> ./bootstrap/ccb.py --project=coriolis \ --devtoolset-2 --make="-j4 install" If you want to uses Qt 5 instead of Qt 4, you may add the ``--qt5`` argument. @@ -150,8 +150,8 @@ In the |Coriolis| |git| repository, two branches are present: development team. To use it instead of the :cb:`master` one, do the following command just after the first step: :: - dummy@lepka:~$ git checkout devel - dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \ + dummy@lepka:~> git checkout devel + dummy@lepka:src> ./bootstrap/ccb.py --project=coriolis \ --make="-j4 install" --debug Be aware that it may requires newer versions of the dependencies and may introduce @@ -160,7 +160,7 @@ In the |Coriolis| |git| repository, two branches are present: In the (unlikely) event of a crash of |cgt|, as it is a |Python| script, the right command to run |gdb| on it is: :: - dummy@lepka:work$ gdb python core.XXXX + dummy@lepka:work> gdb python core.XXXX |newpage| @@ -172,9 +172,9 @@ Additionnal Requirement under |MacOS| seems unable to work with the |Python| bundled with |MacOS|. So you have to install both of them from |macports|: :: - dummy@macos:~$ port install boost +python27 - dummy@macos:~$ port select python python27 - dummy@macos:-$ export DYLD_FRAMEWORK_PATH=/opt/local/Library/Frameworks + dummy@macos:~> port install boost +python27 + dummy@macos:~> port select python python27 + dummy@macos:-> export DYLD_FRAMEWORK_PATH=/opt/local/Library/Frameworks The last two lines tell |MacOS| to use the |Python| from |macports| and *not* from the system. diff --git a/documentation/UsersGuide/ScriptsPlugins.rst b/documentation/UsersGuide/ScriptsPlugins.rst index 2e9e3d0c..8fe35c9e 100644 --- a/documentation/UsersGuide/ScriptsPlugins.rst +++ b/documentation/UsersGuide/ScriptsPlugins.rst @@ -321,7 +321,7 @@ You can generate the chip using one of the following method: #. **Command line mode:** directly run the script: :: - dummy@lepka:AM2901$ ./doChip -V --cell=amd2901 + dummy@lepka:AM2901> ./doChip -V --cell=amd2901 #. **Graphic mode:** launch |cgt|, load chip netlist ``amd2901`` (the top cell) then run the |Python| script :cb:`doChip.py`. @@ -329,4 +329,4 @@ You can generate the chip using one of the following method: .. note:: Between two consecutive run, be sure to erase the netlist/layout generateds: :: - dummy@lepka:AM2901$ rm *_clocked*.vst *.ap + dummy@lepka:AM2901> rm *clocked*.vst *.ap diff --git a/documentation/UsersGuide/UsersGuide.pdf b/documentation/UsersGuide/UsersGuide.pdf index d578d261..bf6e094a 100644 Binary files a/documentation/UsersGuide/UsersGuide.pdf and b/documentation/UsersGuide/UsersGuide.pdf differ diff --git a/documentation/_build/doctrees/Contents.doctree b/documentation/_build/doctrees/Contents.doctree index b4e850b7..8d57f53c 100644 Binary files a/documentation/_build/doctrees/Contents.doctree and b/documentation/_build/doctrees/Contents.doctree differ diff --git a/documentation/_build/doctrees/CrlCore/CrlCore.doctree b/documentation/_build/doctrees/CrlCore/CrlCore.doctree index c59fd7ab..dc688680 100644 Binary files a/documentation/_build/doctrees/CrlCore/CrlCore.doctree and b/documentation/_build/doctrees/CrlCore/CrlCore.doctree differ diff --git a/documentation/_build/doctrees/DpGen/DpGen.doctree b/documentation/_build/doctrees/DpGen/DpGen.doctree index 3fe89591..db25d058 100644 Binary files a/documentation/_build/doctrees/DpGen/DpGen.doctree and b/documentation/_build/doctrees/DpGen/DpGen.doctree differ diff --git a/documentation/_build/doctrees/Hurricane/Hurricane.doctree b/documentation/_build/doctrees/Hurricane/Hurricane.doctree index 6424b3dc..9b728ef0 100644 Binary files a/documentation/_build/doctrees/Hurricane/Hurricane.doctree and b/documentation/_build/doctrees/Hurricane/Hurricane.doctree differ diff --git a/documentation/_build/doctrees/Katabatic/Katabatic.doctree b/documentation/_build/doctrees/Katabatic/Katabatic.doctree index 604f8410..eb405cb8 100644 Binary files a/documentation/_build/doctrees/Katabatic/Katabatic.doctree and b/documentation/_build/doctrees/Katabatic/Katabatic.doctree differ diff --git a/documentation/_build/doctrees/Kite/Kite.doctree b/documentation/_build/doctrees/Kite/Kite.doctree index 85ebbf7d..4e08e67d 100644 Binary files a/documentation/_build/doctrees/Kite/Kite.doctree and b/documentation/_build/doctrees/Kite/Kite.doctree differ diff --git a/documentation/_build/doctrees/Patterns/Patterns.doctree b/documentation/_build/doctrees/Patterns/Patterns.doctree index 29ae4f45..0fdd8a83 100644 Binary files a/documentation/_build/doctrees/Patterns/Patterns.doctree and b/documentation/_build/doctrees/Patterns/Patterns.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/Configuration.doctree b/documentation/_build/doctrees/PythonCpp/Configuration.doctree index 82734a70..fa21a697 100644 Binary files a/documentation/_build/doctrees/PythonCpp/Configuration.doctree and b/documentation/_build/doctrees/PythonCpp/Configuration.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/DBoHierarchy.doctree b/documentation/_build/doctrees/PythonCpp/DBoHierarchy.doctree index 66556e6e..3d49a6dc 100644 Binary files a/documentation/_build/doctrees/PythonCpp/DBoHierarchy.doctree and b/documentation/_build/doctrees/PythonCpp/DBoHierarchy.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/DBoStandalone.doctree b/documentation/_build/doctrees/PythonCpp/DBoStandalone.doctree index 3b2616e1..bbbebaae 100644 Binary files a/documentation/_build/doctrees/PythonCpp/DBoStandalone.doctree and b/documentation/_build/doctrees/PythonCpp/DBoStandalone.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/DbU.doctree b/documentation/_build/doctrees/PythonCpp/DbU.doctree index abec6c78..89164f1c 100644 Binary files a/documentation/_build/doctrees/PythonCpp/DbU.doctree and b/documentation/_build/doctrees/PythonCpp/DbU.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/Introduction.doctree b/documentation/_build/doctrees/PythonCpp/Introduction.doctree index 6a2be816..6fd203d5 100644 Binary files a/documentation/_build/doctrees/PythonCpp/Introduction.doctree and b/documentation/_build/doctrees/PythonCpp/Introduction.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/Name.doctree b/documentation/_build/doctrees/PythonCpp/Name.doctree index 0f70db9b..1ee090b8 100644 Binary files a/documentation/_build/doctrees/PythonCpp/Name.doctree and b/documentation/_build/doctrees/PythonCpp/Name.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/NonDBo.doctree b/documentation/_build/doctrees/PythonCpp/NonDBo.doctree index fc5d7710..5bb67282 100644 Binary files a/documentation/_build/doctrees/PythonCpp/NonDBo.doctree and b/documentation/_build/doctrees/PythonCpp/NonDBo.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/index.doctree b/documentation/_build/doctrees/PythonCpp/index.doctree index 0dffd096..2480443e 100644 Binary files a/documentation/_build/doctrees/PythonCpp/index.doctree and b/documentation/_build/doctrees/PythonCpp/index.doctree differ diff --git a/documentation/_build/doctrees/RDS/RDSpage.doctree b/documentation/_build/doctrees/RDS/RDSpage.doctree index 909e3c1d..fc8a6374 100644 Binary files a/documentation/_build/doctrees/RDS/RDSpage.doctree and b/documentation/_build/doctrees/RDS/RDSpage.doctree differ diff --git a/documentation/_build/doctrees/RDS/index.doctree b/documentation/_build/doctrees/RDS/index.doctree index 22318d67..307ac248 100644 Binary files a/documentation/_build/doctrees/RDS/index.doctree and b/documentation/_build/doctrees/RDS/index.doctree differ diff --git a/documentation/_build/doctrees/Stratus/Stratus.doctree b/documentation/_build/doctrees/Stratus/Stratus.doctree index 1fd0e367..1675b6c6 100644 Binary files a/documentation/_build/doctrees/Stratus/Stratus.doctree and b/documentation/_build/doctrees/Stratus/Stratus.doctree differ diff --git a/documentation/_build/doctrees/Unicorn/Unicorn.doctree b/documentation/_build/doctrees/Unicorn/Unicorn.doctree index e8de0e2b..58551ce7 100644 Binary files a/documentation/_build/doctrees/Unicorn/Unicorn.doctree and b/documentation/_build/doctrees/Unicorn/Unicorn.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/Configuration.doctree b/documentation/_build/doctrees/UsersGuide/Configuration.doctree index 15afc02b..8d30727e 100644 Binary files a/documentation/_build/doctrees/UsersGuide/Configuration.doctree and b/documentation/_build/doctrees/UsersGuide/Configuration.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/Installation.doctree b/documentation/_build/doctrees/UsersGuide/Installation.doctree index ceb83c86..8a5448b0 100644 Binary files a/documentation/_build/doctrees/UsersGuide/Installation.doctree and b/documentation/_build/doctrees/UsersGuide/Installation.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/LicenseCredits.doctree b/documentation/_build/doctrees/UsersGuide/LicenseCredits.doctree index b092b64c..f552aca0 100644 Binary files a/documentation/_build/doctrees/UsersGuide/LicenseCredits.doctree and b/documentation/_build/doctrees/UsersGuide/LicenseCredits.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/Releases.doctree b/documentation/_build/doctrees/UsersGuide/Releases.doctree index d0486ddc..44c644b0 100644 Binary files a/documentation/_build/doctrees/UsersGuide/Releases.doctree and b/documentation/_build/doctrees/UsersGuide/Releases.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/ScriptsPlugins.doctree b/documentation/_build/doctrees/UsersGuide/ScriptsPlugins.doctree index ce9a1dfc..adf3e0b0 100644 Binary files a/documentation/_build/doctrees/UsersGuide/ScriptsPlugins.doctree and b/documentation/_build/doctrees/UsersGuide/ScriptsPlugins.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/ViewerTools.doctree b/documentation/_build/doctrees/UsersGuide/ViewerTools.doctree index 8572d9d5..9e285b67 100644 Binary files a/documentation/_build/doctrees/UsersGuide/ViewerTools.doctree and b/documentation/_build/doctrees/UsersGuide/ViewerTools.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/index.doctree b/documentation/_build/doctrees/UsersGuide/index.doctree index b27bacd9..8b2d8b5b 100644 Binary files a/documentation/_build/doctrees/UsersGuide/index.doctree and b/documentation/_build/doctrees/UsersGuide/index.doctree differ diff --git a/documentation/_build/doctrees/Viewer/Viewer.doctree b/documentation/_build/doctrees/Viewer/Viewer.doctree index 15b8458b..c8890426 100644 Binary files a/documentation/_build/doctrees/Viewer/Viewer.doctree and b/documentation/_build/doctrees/Viewer/Viewer.doctree differ diff --git a/documentation/_build/doctrees/defapi/defapi.doctree b/documentation/_build/doctrees/defapi/defapi.doctree new file mode 100644 index 00000000..5fdbf10e Binary files /dev/null and b/documentation/_build/doctrees/defapi/defapi.doctree differ diff --git a/documentation/_build/doctrees/environment.pickle b/documentation/_build/doctrees/environment.pickle index ccbb62d5..73e6f373 100644 Binary files a/documentation/_build/doctrees/environment.pickle and b/documentation/_build/doctrees/environment.pickle differ diff --git a/documentation/_build/doctrees/etc/definitions.doctree b/documentation/_build/doctrees/etc/definitions.doctree index 446116dd..d02db6b4 100644 Binary files a/documentation/_build/doctrees/etc/definitions.doctree and b/documentation/_build/doctrees/etc/definitions.doctree differ diff --git a/documentation/_build/doctrees/index.doctree b/documentation/_build/doctrees/index.doctree index f2a76316..e0df5d79 100644 Binary files a/documentation/_build/doctrees/index.doctree and b/documentation/_build/doctrees/index.doctree differ diff --git a/documentation/_build/doctrees/lefapi/lefapi.doctree b/documentation/_build/doctrees/lefapi/lefapi.doctree new file mode 100644 index 00000000..1b5a8255 Binary files /dev/null and b/documentation/_build/doctrees/lefapi/lefapi.doctree differ diff --git a/documentation/_build/doctrees/lefdef/lefdef.doctree b/documentation/_build/doctrees/lefdef/lefdef.doctree new file mode 100644 index 00000000..4a1a26d5 Binary files /dev/null and b/documentation/_build/doctrees/lefdef/lefdef.doctree differ diff --git a/documentation/_build/html/.buildinfo b/documentation/_build/html/.buildinfo index 3ba06f68..eae46880 100644 --- a/documentation/_build/html/.buildinfo +++ b/documentation/_build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 1563ffe9c48542af75d7298c4e351220 -tags: fbb0d17656682115ca4d033fb2f83ba1 +config: 83e863ac4925ece5af3eb6ded540e3dc +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/documentation/_build/html/Contents.html b/documentation/_build/html/Contents.html index ca4df365..5d26a33c 100644 --- a/documentation/_build/html/Contents.html +++ b/documentation/_build/html/Contents.html @@ -1,6 +1,5 @@ - @@ -31,6 +30,9 @@ + + @@ -202,15 +204,18 @@
  • The RDS File
    • +
  • LEF API Reference
    • +
  • DEF API Reference
    • +
  • LEF/DEF Language Reference
    • @@ -389,11 +394,11 @@
  • The RDS File
    • @@ -414,7 +419,7 @@ Generated by Sphinx - using a RTD theme on Jul 17, 2017. + using a RTD theme on Oct 30, 2017. @@ -444,7 +449,7 @@