golang/go

cmd/go: clarify documentation for `-overlay` file additions

Open

#51,348 opened on Feb 24, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationGoCommandNeedsFixhelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently, it's possible to replace files using -overlay (https://github.com/golang/go/issues/39958).

However, it only have Replace options:

type OverlayJSON struct {
	Replace map[string]string
}

I would like to suggest a new field, may named as Additions:

type OverlayJSON struct {
        Additions map[string]string
	Replace map[string]string
}

That is useful when using code-generation/meta-programming. In those cases, would be possible to create new go files, or even creating files such as assembly code (.s) or creating syso files (.syso), without need to write it into the package directory. Currently, those files must be written into the package itself, but the -overlay could be used instead.

Contributor guide

Research direction
Study the existing OverlayJSON structure in cmd/go/internal/overlay, then add an Additions field and update the overlay logic to handle new files.
Tech stack
go
Domain
build system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35