Skip to content

Commit d9d56ed

Browse files
author
Chris Busbey
committed
doc changes for generated code changes
1 parent 9cce8a2 commit d9d56ed

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

README.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,22 @@ See [examples](https://github.com/quickfixgo/examples) for some simple examples
3232

3333
### FIX Message Generation
3434

35-
QuickFIX/Go includes fields, enums, messages, and message components generated from the FIX 4.0 - FIX5.0SP2 specs. For most FIX applications, these generated resources are sufficient. Custom FIX applications may generate source specific to the FIX spec of that application using the `generate-fix` tool included with QuickFIX/Go.
35+
QuickFIX/Go includes separate packages for tags, fields, enums, messages, and message components generated from the FIX 4.0 - FIX5.0SP2 specs. See:
36+
37+
* [github.com/quickfixgo/tag](https://github.com/quickfixgo/tag)
38+
* [github.com/quickfixgo/field](https://github.com/quickfixgo/field)
39+
* [github.com/quickfixgo/enum](https://github.com/quickfixgo/enum)
40+
* [github.com/quickfixgo/fix40](https://github.com/quickfixgo/fix40)
41+
* [github.com/quickfixgo/fix41](https://github.com/quickfixgo/fix41)
42+
* [github.com/quickfixgo/fix42](https://github.com/quickfixgo/fix42)
43+
* [github.com/quickfixgo/fix43](https://github.com/quickfixgo/fix43)
44+
* [github.com/quickfixgo/fix44](https://github.com/quickfixgo/fix44)
45+
* [github.com/quickfixgo/fix50](https://github.com/quickfixgo/fix50)
46+
* [github.com/quickfixgo/fix50sp1](https://github.com/quickfixgo/fix50sp1)
47+
* [github.com/quickfixgo/fix50sp2](https://github.com/quickfixgo/fix50sp2)
48+
* [github.com/quickfixgo/fixt11](https://github.com/quickfixgo/fixt11)
49+
50+
For most FIX applications, these generated resources are sufficient. Custom FIX applications may generate source specific to the FIX spec of that application using the `generate-fix` tool included with QuickFIX/Go.
3651

3752
Following installation, `generate-fix` is installed to `$GOPATH/bin/generate-fix`. Run `$GOPATH/bin/generate-fix --help` for usage instructions.
3853

@@ -71,6 +86,16 @@ $ make
7186

7287
If this exits with exit status 0, then everything is working!
7388

89+
### Generated Code
90+
91+
Generated code from the FIX40-FIX50SP2 specs are available as separate repos under the [QuickFIX/Go organization](https://github.com/quickfixgo). The source specifications for this generated code is located in `spec/`. Generated code can be identified by the `.generated.go` suffix. Any changes to generated code must be captured by changes to source in `cmd/generate-fix`. After making changes to the code generator source, run the following to re-generate the source
92+
93+
```sh
94+
$ make generate-dist
95+
```
96+
97+
If you are making changes to the generated code, please create Pull Requests for these changes for the affected repos.
98+
7499
### Acceptance Tests
75100

76101
QuickFIX/Go has a comprehensive acceptance test suite covering the FIX protocol. These are the same tests used across all QuickFIX implementations.
@@ -79,22 +104,15 @@ QuickFIX/Go acceptance tests depend on ruby in path.
79104

80105
To run acceptance tests,
81106

107+
# generate code locally
108+
make generate
109+
82110
# build acceptance test rig
83111
make build_accept
84112

85113
# run acceptance tests
86114
make accept
87115

88-
### Generated Code
89-
90-
For convenience, generated code from the FIX40-FIX50SP2 specs are included in the QuickFIX/Go repo. The source specifications for this generated code is located in `spec/`. Generated code can be identified by the `.generated.go` suffix. Any changes to generated code must be captured by changes to source in `cmd/generate-fix`. After making changes to the code generator source, run the following to re-generate the source
91-
92-
```sh
93-
$ make generate
94-
```
95-
96-
If you are making changes to the generated code, you will need to include the generated source in the same Pull Request as the changes made to the code generator. You should do this in a separate commit from your code, as this makes PR review easier and Git history simpler to read in the future.
97-
98116
### Dependencies
99117

100118
If you are developing QuickFIX/Go, there are a few tasks you might need to perform related to dependencies.

0 commit comments

Comments
 (0)