From 3adee394ec44d0b794ea4e41f59e0ea6a23aa57e Mon Sep 17 00:00:00 2001 From: Sharif Elgamal Date: Tue, 19 Apr 2022 13:41:01 -0700 Subject: [PATCH] fix display order for error codes documentation --- pkg/generate/docs.go | 2 +- pkg/minikube/reason/reason.go | 2 +- site/content/en/docs/contrib/errorcodes.en.md | 222 +++++++++--------- 3 files changed, 113 insertions(+), 113 deletions(-) diff --git a/pkg/generate/docs.go b/pkg/generate/docs.go index de18e7ae87..437ae41957 100644 --- a/pkg/generate/docs.go +++ b/pkg/generate/docs.go @@ -51,7 +51,7 @@ func Docs(root *cobra.Command, path string, testPath string, codePath string) er return errors.Wrap(err, "failed to generate test docs") } - return ErrorCodes(codePath, []string{"pkg/minikube/reason/exitcodes.go", "pkg/minikube/reason/reason.go"}) + return ErrorCodes(codePath, []string{"pkg/minikube/reason/reason.go", "pkg/minikube/reason/exitcodes.go"}) } // DocForCommand returns the specific doc for that command diff --git a/pkg/minikube/reason/reason.go b/pkg/minikube/reason/reason.go index b2fece0172..1b10ae3b60 100644 --- a/pkg/minikube/reason/reason.go +++ b/pkg/minikube/reason/reason.go @@ -95,7 +95,7 @@ var ( InternalConfigUnset = Kind{ID: "MK_CONFIG_UNSET", ExitCode: ExProgramError} // minikube failed to view current config values InternalConfigView = Kind{ID: "MK_CONFIG_VIEW", ExitCode: ExProgramError} - // minikybe failed to delete an internal configuration, such as a cached image + // minikube failed to delete an internal configuration, such as a cached image InternalDelConfig = Kind{ID: "MK_DEL_CONFIG", ExitCode: ExProgramError} // minikube failed to generate script to activate minikube docker-env InternalDockerScript = Kind{ID: "MK_DOCKER_SCRIPT", ExitCode: ExProgramError} diff --git a/site/content/en/docs/contrib/errorcodes.en.md b/site/content/en/docs/contrib/errorcodes.en.md index b6ab67ce83..08e224a7b9 100644 --- a/site/content/en/docs/contrib/errorcodes.en.md +++ b/site/content/en/docs/contrib/errorcodes.en.md @@ -5,116 +5,6 @@ description: > --- -## Error Codes - - -### Generic Errors -1: ExFailure -2: ExInterrupted - -### Error codes specific to the minikube program -10: ExProgramError -14: ExProgramUsage -11: ExProgramConflict -15: ExProgramNotFound -16: ExProgramUnsupported -18: ExProgramConfig - -### Error codes specific to resource limits (exit code layout follows no rules) -20: ExResourceError -23: ExInsufficientMemory -26: ExInsufficientStorage -27: ExInsufficientPermission -29: ExInsufficientCores - -### Error codes specific to the host -30: ExHostError -31: ExHostConflict -32: ExHostTimeout -34: ExHostUsage -35: ExHostNotFound -38: ExHostUnsupported -37: ExHostPermission -38: ExHostConfig - -### Error codes specific to remote networking -40: ExInternetError -41: ExInternetConflict -42: ExInternetTimeout -45: ExInternetNotFound -48: ExInternetConfig -49: ExInternetUnavailable - -### Error codes specific to the libmachine driver -50: ExDriverError -51: ExDriverConflict -52: ExDriverTimeout -54: ExDriverUsage -55: ExDriverNotFound -56: ExDriverUnsupported -57: ExDriverPermission -58: ExDriverConfig -59: ExDriverUnavailable - -### Error codes specific to the driver provider -60: ExProviderError -61: ExProviderConflict -62: ExProviderTimeout -63: ExProviderNotRunning -65: ExProviderNotFound -66: ExProviderUnsupported -67: ExProviderPermission -68: ExProviderConfig -69: ExProviderUnavailable - -### Error codes specific to local networking -70: ExLocalNetworkError -71: ExLocalNetworkConflict -72: ExLocalNetworkTimeout -75: ExLocalNetworkNotFound -77: ExLocalNetworkPermission -78: ExLocalNetworkConfig -79: ExLocalNetworkUnavailable - -### Error codes specific to the guest host -80: ExGuestError -81: ExGuestConflict -82: ExGuestTimeout -83: ExGuestNotRunning -85: ExGuestNotFound -86: ExGuestUnsupported -87: ExGuestPermission -88: ExGuestConfig -89: ExGuestUnavailable - -### Error codes specific to the container runtime -90: ExRuntimeError -93: ExRuntimeNotRunning -95: ExRuntimeNotFound -99: ExRuntimeUnavailable - -### Error codes specific to the Kubernetes control plane -100: ExControlPlaneError -101: ExControlPlaneConflict -102: ExControlPlaneTimeout -103: ExControlPlaneNotRunning -105: ExControlPlaneNotFound -106: ExControlPlaneUnsupported -108: ExControlPlaneConfig -109: ExControlPlaneUnavailable - -### Error codes specific to a Kubernetes service -110: ExSvcError -111: ExSvcConflict -112: ExSvcTimeout -113: ExSvcNotRunning -115: ExSvcNotFound -116: ExSvcUnsupported -117: ExSvcPermission -118: ExSvcConfig -119: ExSvcUnavailable - - ## Error Strings "MK_USAGE" (Exit code ExProgramUsage) @@ -166,7 +56,7 @@ minikube failed to unset an internal config value minikube failed to view current config values "MK_DEL_CONFIG" (Exit code ExProgramError) -minikybe failed to delete an internal configuration, such as a cached image +minikube failed to delete an internal configuration, such as a cached image "MK_DOCKER_SCRIPT" (Exit code ExProgramError) minikube failed to generate script to activate minikube docker-env @@ -543,3 +433,113 @@ a too new Kubernetes version was specified for minikube to use "K8S_DOWNGRADE_UNSUPPORTED" (Exit code ExControlPlaneUnsupported) minikube was unable to safely downgrade installed Kubernetes version +## Error Codes + + +### Generic Errors +1: ExFailure +2: ExInterrupted + +### Error codes specific to the minikube program +10: ExProgramError +14: ExProgramUsage +11: ExProgramConflict +15: ExProgramNotFound +16: ExProgramUnsupported +18: ExProgramConfig + +### Error codes specific to resource limits (exit code layout follows no rules) +20: ExResourceError +23: ExInsufficientMemory +26: ExInsufficientStorage +27: ExInsufficientPermission +29: ExInsufficientCores + +### Error codes specific to the host +30: ExHostError +31: ExHostConflict +32: ExHostTimeout +34: ExHostUsage +35: ExHostNotFound +38: ExHostUnsupported +37: ExHostPermission +38: ExHostConfig + +### Error codes specific to remote networking +40: ExInternetError +41: ExInternetConflict +42: ExInternetTimeout +45: ExInternetNotFound +48: ExInternetConfig +49: ExInternetUnavailable + +### Error codes specific to the libmachine driver +50: ExDriverError +51: ExDriverConflict +52: ExDriverTimeout +54: ExDriverUsage +55: ExDriverNotFound +56: ExDriverUnsupported +57: ExDriverPermission +58: ExDriverConfig +59: ExDriverUnavailable + +### Error codes specific to the driver provider +60: ExProviderError +61: ExProviderConflict +62: ExProviderTimeout +63: ExProviderNotRunning +65: ExProviderNotFound +66: ExProviderUnsupported +67: ExProviderPermission +68: ExProviderConfig +69: ExProviderUnavailable + +### Error codes specific to local networking +70: ExLocalNetworkError +71: ExLocalNetworkConflict +72: ExLocalNetworkTimeout +75: ExLocalNetworkNotFound +77: ExLocalNetworkPermission +78: ExLocalNetworkConfig +79: ExLocalNetworkUnavailable + +### Error codes specific to the guest host +80: ExGuestError +81: ExGuestConflict +82: ExGuestTimeout +83: ExGuestNotRunning +85: ExGuestNotFound +86: ExGuestUnsupported +87: ExGuestPermission +88: ExGuestConfig +89: ExGuestUnavailable + +### Error codes specific to the container runtime +90: ExRuntimeError +93: ExRuntimeNotRunning +95: ExRuntimeNotFound +99: ExRuntimeUnavailable + +### Error codes specific to the Kubernetes control plane +100: ExControlPlaneError +101: ExControlPlaneConflict +102: ExControlPlaneTimeout +103: ExControlPlaneNotRunning +105: ExControlPlaneNotFound +106: ExControlPlaneUnsupported +108: ExControlPlaneConfig +109: ExControlPlaneUnavailable + +### Error codes specific to a Kubernetes service +110: ExSvcError +111: ExSvcConflict +112: ExSvcTimeout +113: ExSvcNotRunning +115: ExSvcNotFound +116: ExSvcUnsupported +117: ExSvcPermission +118: ExSvcConfig +119: ExSvcUnavailable + +