Description

We want to enable golint on our codebase for several reasons:

• We want to improve code quality
• We need objective filters on quality to help us discriminate bad pull requests

How to

Following is the list of all github.com/docker/docker subpackages. For each we need to:

• Submit a PR cleaning all existing golint warnings. One thing to keep in mind is that golint will require that every exported symbol has a comment: favor making symbols private where possible before documenting.
• Enable golint on this package as part of the Jenkins CI jobs to make sure we don't diverge (something that individual contributors can do, but @jfrazelle who owns the testing infrastructure will help with that).

We also need to make it easy for contributors to easily give golint a local run before submitting the PR. We should probably have that script only cover a hardcoded list of packages that we can augment over time.

Packages:

• api (@WeiZhang555 - fix golint errors/warnings of pkg api/ #14844)
• api/client (@brahmaroutu - fix golint errors/warnings #14784)
• api/server (@brahmaroutu - fix golint errors/warnings #14785)
• api/types (@WeiZhang555 - fix golint warnings/errors on package api/types/ #14897)
• builder (@hqhq - Fix golint warnings for builder #14790)
• builder/command (@hqhq - Fix golint warnings for builder #14790)
• builder/parser (@hqhq - Fix golint warnings for builder #14790)
• builder/parser/dumper (@hqhq - Fix golint warnings for builder #14790)
• cliconfig (@MHBauer - golint fixes for cliconfig #14776 & additional lint fix and enable linter for cliconfig package #15175)
• daemon (@MHBauer - golint fixes for daemon/ package #15310)
• daemon/events
• daemon/execdriver (@hqhq - Fix golint warnings for daemon/execdriver/* #14848)
• daemon/execdriver/execdrivers (@hqhq - Fix golint warnings for daemon/execdriver/* #14848)
• daemon/execdriver/lxc (@hqhq - Fix golint warnings for daemon/execdriver/* #14848)
• daemon/execdriver/native (@hqhq - Fix golint warnings for daemon/execdriver/* #14848)
• daemon/execdriver/native/template (@hqhq - Fix golint warnings for daemon/execdriver/* #14848)
• daemon/execdriver/windows (@hqhq - Fix golint warnings for daemon/execdriver/* #14848)
• daemon/graphdriver
• daemon/graphdriver/aufs
• daemon/graphdriver/btrfs (@brahmaroutu - daemon/graphdriver/btrfs fix lint errors/warnings #14875)
• daemon/graphdriver/devmapper (@brahmaroutu - daemon/graphdriver/devmapper/ fix lint errors/warnings #14930)
• daemon/graphdriver/graphtest (@brahmaroutu - daemon/graphdriver/graphtest/ fix lint errors/warnings #14932)
• daemon/graphdriver/overlay (@brahmaroutu - daemon/graphdriver/overlay/ fix lint errors/warnings #15014)
• daemon/graphdriver/vfs (@brahmaroutu - daemon/graphdriver/vfs fix lint errors/warnings #15092)
• daemon/graphdriver/windows
• daemon/graphdriver/zfs (@brahmaroutu - daemon/graphdriver/zfs fix lint errrors/warnings #15269)
• daemon/logger (@MHBauer - golint fixes for daemon/logger/* #14843)
• daemon/logger/fluentd (@MHBauer - golint fixes for daemon/logger/* #14843)
• daemon/logger/gelf (@MHBauer - golint fixes for daemon/logger/* #14843)
• daemon/logger/journald (@MHBauer - golint fixes for daemon/logger/* #14843)
• daemon/logger/jsonfilelog (@MHBauer - golint fixes for daemon/logger/* #14843)
• daemon/logger/syslog (@MHBauer - golint fixes for daemon/logger/* #14843)
• daemon/network (@WeiZhang555 - golint on daemon/network package #14796)
• docker (@sevki - golint fix TLs->TLS in docker/ #14764)
• dockerinit
• graph (@brahmaroutu - /graph fix lint errors/warnings #14827)
• graph/tags (@brahmaroutu - /graph/tag fix lint errors/warnings #14828)
• image (@brahmaroutu - image fix lint errors/warnings #14786)
• integration-cli (@bfirsh - Golint integration-cli #14851)
• links (@runcom - Cleanup links top level pkg #14773)
• opts (@sevki - lint: opts, trust #14813 carried in Carry #14813 on linting package opts and trust #15882)
• pkg/archive (@coolljt0725 - Enable golint in pkg/archive #15252)
• pkg/broadcastwriter (@coolljt0725 - Enable golint, part of #14756 #15013)
• pkg/chrootarchive
• pkg/devicemapper
• pkg/directory
• pkg/fileutils
• pkg/graphdb (@coolljt0725 - Enable golint, part of #14756 #15013)
• pkg/homedir
• pkg/httputils (@coolljt0725 - Enable golint, part of #14756 #15013)
• pkg/ioutils (@coolljt0725 - Enable golint, part of #14756 #15013)
• pkg/jsonlog (@coolljt0725 - Enable golint in pkg/jsonlog and pkg/jsonmessage part of #14756 #15074)
• pkg/jsonmessage (@coolljt0725 - Enable golint in pkg/jsonlog and pkg/jsonmessage part of #14756 #15074)
• pkg/listenbuffer
• pkg/mflag (@fcantournet - Fix golint for pkg/mflag #14824)
• pkg/mflag/example
• pkg/mount (@runcom - pkg: mount: golint #14817)
• pkg/namesgenerator (@dave-tucker - golint: Lint pkg/namesgenerator #14805)
• pkg/nat (@dave-tucker - golint: Fix issues in pkg/nat #14804)
• pkg/parsers (@vdemeester - golint on some pkg/* packages #14759)
• pkg/parsers/filters (@vdemeester - golint on some pkg/* packages #14759)
• pkg/parsers/kernel (@vdemeester - golint on some pkg/* packages #14759)
• pkg/parsers/operatingsystem (@vdemeester - golint on some pkg/* packages #14759)
• pkg/pidfile (@vdemeester - golint on some pkg/* packages #14759)
• pkg/plugins (@vdemeester - golint on some pkg/* packages #14759)
• pkg/plugins/pluginrpc-gen
• pkg/plugins/pluginrpc-gen/fixtures
• pkg/pools (@vdemeester - golint on some pkg/* packages #14759)
• pkg/progressreader (@vdemeester - golint on some pkg/* packages #14759)
• pkg/promise
• pkg/proxy (@vdemeester - golint on some pkg/* packages #14759)
• pkg/pubsub
• pkg/random
• pkg/reexec (@LK4D4 - Add docstring to reexec.Command #14762)
• pkg/signal (@vdemeester - golint on some pkg/* packages #14759)
• pkg/sockets (@vdemeester - golint on some pkg/* packages #14759)
• pkg/stdcopy (@WeiZhang555 - fix golint warnings/errors on pkg/system and pkg/stdcopy #15125)
• pkg/streamformatter (@vdemeester - golint on some pkg/* packages #14759)
• pkg/stringid (@vdemeester - golint on some pkg/* packages #14759)
• pkg/stringutils (@vdemeester - golint on some pkg/* packages #14759)
• pkg/symlink
• pkg/sysinfo (@HuKeping - Fix golint warning on pkg/sysinfo #14840)
• pkg/system (@WeiZhang555 - fix golint warnings/errors on pkg/system and pkg/stdcopy #15125)
• pkg/systemd (@vdemeester - golint on some pkg/* packages #14759)
• pkg/tailfile (@vdemeester - golint on some pkg/* packages #14759)
• pkg/tarsum (@vdemeester - golint on some pkg/* packages #14759)
• pkg/term (@vdemeester - golint on some pkg/* packages #14759)
• pkg/term/windows (@vdemeester - Lint pkg/term/windows package #16060)
• pkg/timeoutconn (@vdemeester - golint on some pkg/* packages #14759)
• pkg/timeutils
• pkg/tlsconfig
• pkg/truncindex (@vdemeester - golint on some pkg/* packages #14759)
• pkg/ulimit (@vdemeester - golint on some pkg/* packages #14759)
• pkg/units (@vdemeester - golint on some pkg/* packages #14759)
• pkg/urlutil
• pkg/useragent (@vdemeester - golint on some pkg/* packages #14759)
• pkg/version
• registry (@aaronlehmann - Improve documentation and golint compliance of registry package #14835)
• runconfig (@vdemeester - golint fixes on runconfig #14751)
• trust (@sevki - lint: opts, trust #14813 carried in Carry #14813 on linting package opts and trust #15882)
• utils (@HuKeping - golint: use golint to check package util #14801)
• volume (@MHBauer - lint for volume/* #14818)
• volume/drivers (@MHBauer - lint for volume/* #14818)
• volume/local (@MHBauer - lint for volume/* #14818)

Final task:

• Enable golint as part of CI on all non-vendored subpackage (I have the patch ready to fire)