1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
.\"
.\" srecord - manipulate eprom load files
.\" Copyright (C) 2001, 2002, 2004 Peter Miller;
.\" All rights reserved.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
.\"
.\" MANIFEST: etc/new-file-format.o
.\"
.TH "New Format" "SRecord" "SRecord" "Reference Manual"
.SH NAME
How to add a new file format
.XX "" "How to add a new file format"
.SH DESCRIPTION
This section describes how to add a new file format. It's mostly a
set of reminders for the maintainer. If you want a format added
to the distribution, use this method and e-mail the maintainer a patch
(generated with diff -u -r, usually) and it can be added to the sources
if appropriate.
.SS New Files
The following files need to be create for a new format.
.TP 8n
lib/srec/output/file/\fIname\fP.cc
This file is how to write the new format.
Take a look at the other files in the same directory
for examples. Also check out \fIinclude/srec/output/file.h\fP and
\fIinclude/srec/output.h\fP for various helper methods.
.TP 8n
include/srec/output/file/\fIname\fP.h
This is the class declaration for the above file.
.TP 8n
lib/srec/input/file/\fIname\fP.cc
This file is how to read the new format.
Take a look at the other files in the same directory
for examples. Also check out \fIinclude/srec/input/file.h\fP and
\fIinclude/srec/input.h\fP for various helper methods.
.TP 8n
include/srec/input/file/\fIname\fP.h
This is the class declaration for the above file.
.TP 8n
man/man5/srec_\fIname\fP.5
This file describes the format. Take a look at the other files in the
same directory for examples.
.SS Modified Files
The following files need to be updated to mention the new format.
.TP 8n
etc/README.man
Mention the new format in the section of this file which describes
the supported file formats.
.TP 8n
etc/srecord.html
Mention the new format in the section of this file which describes
the supported file formats.
.TP 8n
include/srec/arglex.h
Add the new format to the command line argument type enum.
.TP 8n
lib/srec/arglex.cc
Add the new format to the array of command line arguments types.
.TP 8n
lib/srec/arglex/input.cc
Add the new format to the code which parses input formats.
.TP 8n
lib/srec/arglex/output.cc
Add the new format to the code which parses output formats.
.TP 8n
lib/srec/input/file/guess.cc
Add the new format to the list of formats which are tested.
.TP 8n
man/man1/o_input.so
Mention the new format in the section of this file which describes
the supported input file formats.
.TP 8n
man/man1/srec_cat.1
Mention the new format in the section of this file which describes
the supported output file formats.
.TP 8n
Makefile
Actually, the system the maintainer uses automatically generates this
file, but if you aren't using Aegis you will need to edit this file for
your own use.
.SH AUTHOR
.TS
tab(;);
l l l.
Peter Miller;E-Mail:;millerp@canb.auug.org.au
\f(CW/\e/\e*\fP;WWW:;http://www.canb.auug.org.au/~millerp/
.TE
|