File format lacks comments

Bug #699537 reported by whitis
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
gEDA project
New
Wishlist
Unassigned
pcb
New
Wishlist
Unassigned

Bug Description

The pcb file format lacks a provision for comments. Two
types of comments should be added to both pcb files
and element files:

Simple file comments:
   // This is a comment
   // Generated by protel2pcb
These comments will not be preserved across edits.

Comment objects:
   Element[....]
   {
        Comment["Footprint copyright 2004 by John Doe"]
        Comment["element_filename='foo/bar/baz'"]
        Comment["vendor[0].name='digikey'"]
        Comment["vendor[0].part_no='500K-ND'"]
        Comment["vendor[0].price='$2.50']
        Comment["stencil_thickness=10mils"]
        Comment["height=5mm"]
        Comment["hole_tolerance={plus=10mils,minus=5mils}"]
        ....
   }
These comments will not be displayed in the editor
(unless someone wants to add a dialog box later) but
will be preserved across edits.

These objects could occur:
  - Inside an element in an element file
  - Inside an element embedded in a board file
  - Elsewhere in an element file

For compatibilty with older tools that read pcb files, one
could always use:
   cat file.pcb | fgrep -v "Comment[" | egrep -v "^//"
to strip off both types of comments.

Revision history for this message
whitis (whitis-users-sf) wrote :

Ok, looks like pcb does allow one form of comment. Lines
beginning with "#" appear to be comments although the comments
at the begining of the file actually look like non-comment lines
since they contain data and some programs use # for metadata
(The most common example, "#define" in C).
 And a search of parse_y.y and parse_y.l yielded no match
for "comment" or "remark". They may be handled in a crude
way outside the parser/lex analyzer.

Still need comment objects, though.

Revision history for this message
Colin D Bennett (colinb) wrote :

It seems like the Comment objects are not needed since the Attribute object could be used instead.

See the following messages: DJ Delorie's addition of Attribute object <http://ftp.sunet.se/geda/mailinglist/geda-dev87/msg00103.html> and another message by DJ about Attributes <http://ftp.sunet.se/geda/mailinglist/geda-dev87/msg00106.html>.

Traumflug (mah-jump-ing)
Changed in geda-project:
importance: Undecided → Wishlist
tags: added: file-format
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.