47775a8fa0
In order to be able to build the documentation without internet access (as is required by some distribution build systems), all of the source code needed for the build needs to be available in the source tarball. This used to be possible with the docker-cli sources but was accidentally broken with some CI changes that switched to downloading the tools (by modifying go.mod as part of the docs build script). This pattern also maked documentation builds less reproducible since the tool version used was not based on the source code version. Fixes:7dc35c03fc("validate manpages target") Fixes:a650f4ddd0("switch to cli-docs-tool for yaml docs generation") Signed-off-by: Aleksa Sarai <cyphar@cyphar.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
75 lines
2.0 KiB
Go
75 lines
2.0 KiB
Go
// Copyright 2016 cli-docs-tool authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package clidocstool
|
|
|
|
import (
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/cobra/doc"
|
|
)
|
|
|
|
// GenManTree generates a man page for the command and all descendants.
|
|
// If SOURCE_DATE_EPOCH is set, in order to allow reproducible package
|
|
// builds, we explicitly set the build time to SOURCE_DATE_EPOCH.
|
|
func (c *Client) GenManTree(cmd *cobra.Command) error {
|
|
if err := c.loadLongDescription(cmd, "man"); err != nil {
|
|
return err
|
|
}
|
|
|
|
if epoch := os.Getenv("SOURCE_DATE_EPOCH"); c.manHeader != nil && epoch != "" {
|
|
unixEpoch, err := strconv.ParseInt(epoch, 10, 64)
|
|
if err != nil {
|
|
return fmt.Errorf("invalid SOURCE_DATE_EPOCH: %v", err)
|
|
}
|
|
now := time.Unix(unixEpoch, 0)
|
|
c.manHeader.Date = &now
|
|
}
|
|
|
|
return c.genManTreeCustom(cmd)
|
|
}
|
|
|
|
func (c *Client) genManTreeCustom(cmd *cobra.Command) error {
|
|
for _, sc := range cmd.Commands() {
|
|
if err := c.genManTreeCustom(sc); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// always disable the addition of [flags] to the usage
|
|
cmd.DisableFlagsInUseLine = true
|
|
|
|
// always disable "spf13/cobra" auto gen tag
|
|
cmd.DisableAutoGenTag = true
|
|
|
|
// Skip the root command altogether, to prevent generating a useless
|
|
// md file for plugins.
|
|
if c.plugin && !cmd.HasParent() {
|
|
return nil
|
|
}
|
|
|
|
log.Printf("INFO: Generating Man for %q", cmd.CommandPath())
|
|
|
|
return doc.GenManTreeFromOpts(cmd, doc.GenManTreeOptions{
|
|
Header: c.manHeader,
|
|
Path: c.target,
|
|
CommandSeparator: "-",
|
|
})
|
|
}
|