doc/standards.rst
author Andrey Skvortsov <andrej.skvortzov@gmail.com>
Sat, 09 Jun 2018 17:13:16 +0300
changeset 2181 52630996e51b
parent 811 66a8812457d6
child 3925 1d383b4c0a23
permissions -rw-r--r--
Add command line argument to run linter only on changed files

./tests/tools/check_source.sh --only-changes

It's recommended to run check_source.sh automatically on each commit,
so the rules are always enforced.
Even better is to use docker for that, so the versions of pep8 and
pylint are the same as on pipeline server.

To do this couple of lines should be added into repository's hgrc file.

[----------- cut from .hg/hgrc------------------]

[hooks]
precommit.linter = ./tests/tools/check_source.sh --only-changes
# precommit.linter = docker run -it --volume=$PWD:/beremiz --workdir="/beremiz" --volume=$PWD/../CanFestival-3:/CanFestival-3 --memory=1g --entrypoint=/beremiz/tests/tools/check_source.sh skvorl/beremiz-requirements --only-changes

[-----------------------------------------------]
IEC 61131-3
===========

    IEC-61131 is a normative document provided by the standards organization IEC
    (International Electrotechnical Commission) and describing a standard for
    implementing programmable controllers.


    The part 3 of this document (commonly named IEC 61131-3) specifies syntax and 
    semantics for programming language for programmable controllers. Beremiz
    implements all the languages described in this document. 


    http://www.iec.eu
        
PLCopen TC6
===========
   
    PLCopen is a vendor- and product-independent worldwide association defining
    international standards for various topics related to control programming.
    For this purpose, PLCopen has 6 technical committees.
   
   
    The goal of the sixth committee (TC6) is to define a standard file format, 
    based on XML, for exchanging programmables controllers programmed using 
    IEC 61131-3 languages. Beremiz uses this file format for saving the PLC
    programs of projects.
   
   
    http://www.plcopen.org