Control: tags -1 + patch On Fri, Jun 05, 2020 at 10:23:33PM +0000, Noah Meyerhans wrote: > The ECR credential helper is used transparently by docker if the appropriate > statements are included in ~/.docker/config.json, but the installed package > contains no documentation describing this process. > > At a minimum, including the README.md from the source repository would help, > as > it contains this information.
As discussed outside the BTS, there is a man page, but its name corresponds with a binary that a user would never directly execute (it is run automatically by docker). So it's not really clear which man page to consult to learn the proper configuration. So, it would still be helpful to have README.md in place. Alternatively, symlinking the manual page to something more easily discoverable could help. Since there's no binary named "amazon-ecr-credential-helper", it should not go in section 1. Section 7 seems most appropriate. But then the man page's header would be wrong. (it'd still reference section 1) The attached patch will install README.md to the appropriate place. noah
diff -Nru amazon-ecr-credential-helper-0.3.1/debian/amazon-ecr-credential-helper.docs amazon-ecr-credential-helper-0.3.1/debian/amazon-ecr-credential-helper.docs --- amazon-ecr-credential-helper-0.3.1/debian/amazon-ecr-credential-helper.docs 1969-12-31 16:00:00.000000000 -0800 +++ amazon-ecr-credential-helper-0.3.1/debian/amazon-ecr-credential-helper.docs 2020-06-05 16:03:35.000000000 -0700 @@ -0,0 +1 @@ +README.md diff -Nru amazon-ecr-credential-helper-0.3.1/debian/changelog amazon-ecr-credential-helper-0.3.1/debian/changelog --- amazon-ecr-credential-helper-0.3.1/debian/changelog 2019-12-31 15:55:36.000000000 -0800 +++ amazon-ecr-credential-helper-0.3.1/debian/changelog 2020-06-05 16:04:11.000000000 -0700 @@ -1,3 +1,9 @@ +amazon-ecr-credential-helper (0.3.1-2) UNRELEASED; urgency=medium + + * Install README.md to /usr/share/doc (Closes: #962304) + + -- Noah Meyerhans <no...@debian.org> Fri, 05 Jun 2020 16:04:11 -0700 + amazon-ecr-credential-helper (0.3.1-1) unstable; urgency=low [ Noah Meyerhans ]
