[PATCH] D114429: [objcopy][NFC] Add doc comments to the executeObjcopy* functions.

[James Henderson via Phabricator via llvm-commits]

jhenderson added inline comments.


================
Comment at: llvm/include/llvm/Object/ObjCopy/COFF/COFFObjcopy.h:27
+/// Applies the transformations described by \p Config to
+/// \p In(FileFormat::Unspecified) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
----------------
jhenderson wrote:
> 
See below: actually just delete the bit in brackets, so it's "... \p In and writes...".


================
Comment at: llvm/include/llvm/Object/ObjCopy/ELF/ELFObjcopy.h:41
+/// Applies the transformations described by \p Config and \p ELFConfig to
+/// \p In(FileFormat::ELF or FileFormat::Unspecified) and writes
+/// the result into \p Out.
----------------
avl wrote:
> avl wrote:
> > jhenderson wrote:
> > > I'm a little thrown by the "Unspecified" format. I'm guessing that's just because earlier logic will detect that the input buffer is an ELF file if no explicit input format is specified, and feed it through to here. If that's the case, we shouldn't be mentioning this case, since in both cases, we're working with an ELF file.
> > The idea of these descriptions is to match with values which are in: 
> > 
> > ```
> > struct CommonConfig {
> > ...
> >   FileFormat InputFormat = FileFormat::Unspecified;
> > ...
> > };
> > 
> > enum class FileFormat {
> >   Unspecified,
> >   ELF,
> >   Binary,
> >   IHex,
> > };
> > 
> > ```
> > It would probably be better to make FileFormat more descriptive by adding values: COFF, MachO, Wasm instead of Unspecified; RawELF instead of Binary... But I think this refactoring should be done separately. The idea of current doc comments is to show connection of CommonConfig.InputFormat and corresponding executeObjcopyOn* functions.
> Current logic is that Unspecified is used for all formats:
> 
> 
> ```
>   // FIXME:  Currently, we ignore the target for non-binary/ihex formats
>   // explicitly specified by -I option (e.g. -Ielf32-x86-64) and guess the
>   // format by llvm::object::createBinary regardless of the option value.
>   Config.InputFormat = StringSwitch<FileFormat>(InputFormat)
>                            .Case("binary", FileFormat::Binary)
>                            .Case("ihex", FileFormat::IHex)
>                            .Default(FileFormat::Unspecified);
> 
> ```
> 
> 
> So, How about that variant:
> 
> 
> ```
> /// Applies the transformations described by \p Config and \p ELFConfig to
> /// \p In, which must be an ELF object(FileFormat::Unspecified), and writes
> /// the result into \p Out.
> ```
> 
> ?
> 
> 
The FileFormat specified in the Config is completely irrelevant in these functions - a future piece of code may not use the FileFormat, so mentioning it in the comments is confusing at best, and at worst directly misleading.

What matters is what the code in the function expects the format of the input to be. In fact, I realised in this case that we are already passing in an `ELFObjectFileBase` for `In`, so we probably don't need to say anything specifically about `In` at all, i.e. the comment should be "... to \p In and writes ..."


================
Comment at: llvm/include/llvm/Object/ObjCopy/MachO/MachOObjcopy.h:28
+/// Applies the transformations described by \p Config and \p MachOConfig to
+/// \p In(FileFormat::Unspecified) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
----------------
jhenderson wrote:
> I'm assuming this is correct, i.e. that the input binary must be Mach-O to get here?
Scratch this: just delete the the bit between "In" and the "and writes". The type is already defined by the type of In.


================
Comment at: llvm/include/llvm/Object/ObjCopy/MachO/MachOObjcopy.h:35
+/// Applies the transformations described by \p Config and \p MachOConfig to
+/// \p In(FileFormat::Unspecified) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
----------------
jhenderson wrote:
> 
Same as above: delete the bit after "In" up to (but not including) "and writes".


================
Comment at: llvm/include/llvm/Object/ObjCopy/wasm/WasmObjcopy.h:26
+/// Applies the transformations described by \p Config to
+/// \p In(FileFormat::Unspecified) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
----------------
jhenderson wrote:
> 
As above, just delete the bit between "In" and "and writes".


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D114429/new/

https://reviews.llvm.org/D114429