add documentation comments to dockerfile #1254
Conversation
I gave whiskers to the cats. The lack of wrap-width consistency is driving me a little bit crazy. I don't suppose there's anything we can do about those long --mount lines, but everything else could be hard wrapped/re-wrapped at some width. 80 is a bit short for this file, but 100 would be a bit wide. Lines 18-22 are wrapped at about 90 which feels right. |
There was a problem hiding this comment.
The lack of wrap-width consistency is driving me a little bit crazy. I don't suppose there's anything we can do about those long --mount lines, but everything else could be hard wrapped/re-wrapped at some width. 80 is a bit short for this file, but 100 would be a bit wide. Lines 18-22 are wrapped at about 90 which feels right.
It's fine with me if you want to fix that here. I would just ask that you not re-expand the command lines that are already split up - like createrepo_c and dnf -y - since I find the current format more readable. But the comments and the very long find commands are fair game.
I placed a ruler on the right-most cat whisker and wrapped things that overhung it. I rewrapped comments that were at a shorter width. To me this is much prettier. Unfortunately the RUN --mount lines that are long cannot be wrapped and have their next line indented (no spaces allowed), but I think even this less-ideal wrap is better than hanging off the edge of the world. |
Some separation and comments in the Dockerfile to help those who may be reading it for the first time.
Some separation and comments in the Dockerfile to help those who may be
reading it for the first time.
Issue number:
N/A
Description of changes:
I'm trying to better understand the build process and found it difficult to get a foothold in the Dockerfile. I think this may help the next person.
Explaining what
RUN --mount=target=/hostmeans at the top might seem weird, but I spent a lot of time digging to try and figure that out. Eventually I had to test it in a minimal Dockerfile to actually get it (the documentation I found didn't fully illuminate that buidlkit feature for me).Adding the cat separators before each
FROMmakes it easier to scroll back and reference the previous build stage.Testing done:
N/A
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.