1417658 - Consider unifying export_suffixes for GeneratedFiles

Status: RESOLVED FIXED

(Firefox Build System :: General, enhancement)

Description

[Michael Shal [:mshal]]

The RecursiveMake backend has a list of export_suffixes, which is how it determines whether or not a particular GeneratedFile object needs to be built before compilation, or if it can be built after. The tup backend is starting to use a similar list, and any other backend is likely to need a similar list. If this is the same across backends, we should probably move it somewhere in the GeneratedFile object itself so that it has a way of self-identifying that it's needed before/after compilation.

Comment 1

[Michael Shal [:mshal]]

Attachment: Bug 1417658 - Move export_suffixes into GeneratedFile;

I believe all backends will need to know which GeneratedFiles are needed
before compilation can start, so we should make that an attribute of the
object. Each backend can then make its own decision about what to do
with the different types of GeneratedFiles.

Review commit: https://reviewboard.mozilla.org/r/202206/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/202206/

Comment 2

[Nick Alexander :nalexander [he/him]]

Comment on attachment 8931127 [details]
Bug 1417658 - Move export_suffixes into GeneratedFile;

https://reviewboard.mozilla.org/r/202206/#review207568

Both me and ted are active in this area of the code, so I'm happy to see an abstraction grow around this warty bit.

::: python/mozbuild/mozbuild/backend/recursivemake.py:523
(Diff revision 1)
>              self._process_defines(obj, backend_file, which='HOST_DEFINES')
>          elif isinstance(obj, Defines):
>              self._process_defines(obj, backend_file)
>  
>          elif isinstance(obj, GeneratedFile):
> -            export_suffixes = (
> +            tier = 'export' if obj.required_for_compilation else 'misc'

nit: slight preference for "compile" rather than "compilation", for string matching.

Comment 3

[Michael Shal [:mshal]]

Comment on attachment 8931127 [details]
Bug 1417658 - Move export_suffixes into GeneratedFile;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/202206/diff/1-2/

Comment 4

[Chris Manchester (limited bugmail, email directly)]

Comment on attachment 8931127 [details]
Bug 1417658 - Move export_suffixes into GeneratedFile;

https://reviewboard.mozilla.org/r/202206/#review207574

::: python/mozbuild/mozbuild/frontend/data.py:1070
(Diff revision 2)
>          self.method = method
>          self.outputs = outputs if isinstance(outputs, tuple) else (outputs,)
>          self.inputs = inputs
>          self.flags = flags
>  
> +        export_suffixes = (

There isn't much sense in calling these `export_suffixes` now.

Comment 5

[Michael Shal [:mshal]]

(In reply to Chris Manchester (:chmanchester) from comment #4)
> > +        export_suffixes = (
> 
> There isn't much sense in calling these `export_suffixes` now.

Yeah, I guess it's a little make specific. Any preferences? It is just a local variable, so I'm not tied to it.

Comment 6

[Michael Shal [:mshal]]

Comment on attachment 8931127 [details]
Bug 1417658 - Move export_suffixes into GeneratedFile;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/202206/diff/2-3/

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/6f8cc047e7e4
Move export_suffixes into GeneratedFile; r=nalexander

Comment 8

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/6f8cc047e7e4