bugModula-2 Compiler and Translator - Bugs: bug #44788, Documentation: Extensions and...

 
 

bug #44788: Documentation: Extensions and Limitations

Submitter:  None
Submitted:  Thu 09 Apr 2015 07:03:59 AM UTC
   
 
Category:  None Severity:  3 - Normal
Item Group:  None Status:  Confirmed
Privacy:  Public Assigned to:  None
Open/Closed:  Open
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 30 Apr 2015 10:50:26 PM UTC, comment #1: 

Agreed.

The documentation is not that great, and the comments are disruptive, and often unhelpful. The comments should be modified or removed on a case by case basis. Some of the extensions are mentioned in differing places, but should be mentioned in the man page as extensions (or perhaps removed as extensions). Accurate and complete documentation is good; inaccurate documentation is a bug.

For the record, I'm fine with anything that's part of the ISO standard, or from Oberon, as long as it is consistent with PIM4. Patches are welcome.

David Egan Evans <sinuhe>
Group administrator
Thu 09 Apr 2015 07:03:59 AM UTC, original submission:  

Language extensions and limitations should be documented in a separate document. At present one has to read all the sources which is very painful given the horrible gibberish the comments are written in.

For example: m2c ads ISO function VAL, Oberon function ENTIER and C code inlining using {% ... %} syntax. It also ads several types: BYTE, SHORTCARD, SHORTINT, SHORTREAL, LONGCARD. This should be documented.

The minima and maxima of types should be documented. SET types appear to be limited to the number of elements equal to the bitwidth of the integer type of the C implementation of the target platform. This should be documented. Ideally, this limit would be set to a guaranteed minimum like 128 elements.

Last but not least it should be documented where the compiler looks for source code, M2 libraries, C libraries and include files.

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by sinuhe (Posted a comment)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follows 1 latest change.

    Date Changed by Updated Field Previous Value => Replaced by
    2015-04-30 sinuhe StatusNone Confirmed

    Back to the top

    Powered by Savane 3.13-f8d8.
    Corresponding source code