golang/go

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

Open

#51.348 aperta il 24 feb 2022

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Go (19.008 fork)batch import
DocumentationGoCommandNeedsFixhelp wanted

Metriche repository

Star
 (133.883 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Questa issue richiede un campo 'Additions' nella struct OverlayJSON per consentire l'aggiunta di nuovi file senza doverli effettivamente scrivere su disco. L'attuale campo Replace supporta solo la sostituzione. Per implementarlo, sarebbe necessario modificare il codice interno di gestione dell'overlay in cmd/go, probabilmente in file come 'src/cmd/go/internal/overlay/overlay.go'. La PR collegata all'issue #39958 potrebbe fornire contesto. I maintainer non hanno ancora commentato le decisioni di progettazione, quindi è necessaria un'ulteriore indagine su come l'overlay viene applicato durante le build.
Tech stack
go
Dominio
build system
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
35