Skip to content

makefiles: documentation for hexfile binfile#11845

Merged
leandrolanzieri merged 2 commits intoRIOT-OS:masterfrom
cladmi:pr/make/documentation/hexfile_binfile
Jul 16, 2019
Merged

makefiles: documentation for hexfile binfile#11845
leandrolanzieri merged 2 commits intoRIOT-OS:masterfrom
cladmi:pr/make/documentation/hexfile_binfile

Conversation

@cladmi
Copy link
Contributor

@cladmi cladmi commented Jul 15, 2019

Contribution description

Now that HEXFILE is not overwritten to a .bin anymore and BINFILE always a binary file, the documentation can be clarified.

Testing procedure

Review the new documentation in makefiles/vars.inc.mk.

The value of HEXFILE is not overwritten anymore (to BINFILE in particular)

git grep 'HEXFILE \?:\?=' '**' ':!boards/common/msba2/tools/flashutil.sh'
# empty

The value can be seen in the info-build output.

make -C examples/hello-world/ info-build | grep FILE:  | head -n 4
ELFFILE: /home/harter/work/git/RIOT/examples/hello-world/bin/native/hello-world.elf
HEXFILE: /home/harter/work/git/RIOT/examples/hello-world/bin/native/hello-world.hex
BINFILE: /home/harter/work/git/RIOT/examples/hello-world/bin/native/hello-world.bin
FLASHFILE: /home/harter/work/git/RIOT/examples/hello-world/bin/native/hello-world.elf

Issues/PRs references

Part of #8838

@cladmi cladmi changed the title makefiles: documentation and usage for hexfile binfile makefiles: documentation for hexfile binfile Jul 15, 2019
@cladmi cladmi mentioned this pull request Jul 15, 2019
Merged
49 tasks
@leandrolanzieri leandrolanzieri added Area: build system Area: Build system Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation labels Jul 16, 2019
@leandrolanzieri leandrolanzieri self-requested a review July 16, 2019 08:19
@leandrolanzieri leandrolanzieri added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jul 16, 2019
cladmi added 2 commits July 16, 2019 12:05
@cladmi
makefiles/vars.inc.mk: update documentation for HEXFILE
065f85c 
HEXFILE is not overwritten to be sometimes a '.bin' file anymore.
Its format can now be documented as an 'intel hex' file.
@cladmi
makefiles: documentation for BINFILE
b62488e 
Document `BINFILE` in the same ways as `HEXFILE`.
The file does not need to be exported so no reason to do it though.

It also adds it in the `info-build` output in the same way as `HEXFILE`.
@cladmi cladmi force-pushed the pr/make/documentation/hexfile_binfile branch from e3d3edd to b62488e Compare July 16, 2019 10:05
@cladmi
Copy link
Contributor Author

cladmi commented Jul 16, 2019

Fixed commit message typos mentioned IRL. sometimeS and be precise with intel hex instead of just ihex.

@leandrolanzieri leandrolanzieri added Reviewed: 1-fundamentals The fundamentals of the PR were reviewed according to the maintainer guidelines Reviewed: 3-testing The PR was tested according to the maintainer guidelines Reviewed: 5-documentation The documentation details of the PR were reviewed according to the maintainer guidelines labels Jul 16, 2019
leandrolanzieri
leandrolanzieri approved these changes Jul 16, 2019
View reviewed changes
Copy link
Contributor

@leandrolanzieri leandrolanzieri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. ACK.

@leandrolanzieri leandrolanzieri merged commit 0c3ca4e into RIOT-OS:master Jul 16, 2019
@cladmi
Copy link
Contributor Author

cladmi commented Jul 16, 2019

Thank you for the review.

@cladmi cladmi deleted the pr/make/documentation/hexfile_binfile branch July 16, 2019 13:06
@kb2ma kb2ma added this to the Release 2019.10 milestone Sep 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leandrolanzieri leandrolanzieri leandrolanzieri approved these changes

Assignees

No one assigned

Labels

Area: build system Area: Build system CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Reviewed: 1-fundamentals The fundamentals of the PR were reviewed according to the maintainer guidelines Reviewed: 3-testing The PR was tested according to the maintainer guidelines Reviewed: 5-documentation The documentation details of the PR were reviewed according to the maintainer guidelines Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation

Projects

None yet

Milestone

Release 2019.10

Development

Successfully merging this pull request may close these issues.

3 participants

@cladmi @leandrolanzieri @kb2ma