Commits on Jul 31, 2023

1. [stable-2.14] Fix misrendered sections in manpage generation …

   This change fixes bugs in the manpage generator that existed since it
   was first added.
   
   It exposes CLI `ARGUMENTS` value to manpage templates.
   
   Before this change, the code contained a typo, causing the `for`-loop
   iterate over individual characters of the `'ARGUMENTS'` string rather
   than iterating over a tuple. A missing comma was at fault.
   
   The updated code gets rid of the `for`-loop and conditionals since it
   seems to have been a premature complexity increase and no other things
   than `'ARGUMENTS'` were ever added into the broken iterable.
   
   The functional change is that `arguments` is now always present in the
   Jinja2 context, unlike being missing sometimes because of the previous
   design (not that it was ever present, because of the bug! sigh...)
   
   The Jinja2 templates perform an `{% if arguments %}` check, letting
   the template engine silently ignore the missing variable. The clause
   was always falsy, meaning that the arguments section was not included
   in the manpages for at least the last 6 years. With this fix, it will
   be.
   
   This patch also deduplicates calling `opt_doc_list` @ generate_man.
   
   It was called late in the execution, more times than necessary. This
   patch makes sure it happens once by putting it at the top of the scope.
   
   It fixes rendering library and inventory in manpages.
   
   The corresponding Jinja2 templates have blocks wrapped with
   conditionals like `{% if inventory %}` and `{% if library %}` but said
   variables were never injected into the context, nor were they even
   deduced on the Python side of the generator. This means that the
   conditional clauses were always falsy, never showing the portions of
   the manpages.
   
   The Python script has hints for how the `inventory` variable was to be
   calculated, which is confirmed through the Git paleontology efforts.
   
   The block of code that references to the `inventory` bit was
   incorrectly checking a variable with a list of nested objects for the
   presence of a string which was never going to work.
   
   This patch fixes this check by verifying the CLI flag against the
   correct variable containing a list of options and exposes it to the
   Jinja2 templates.
   It also exposes the `library` variable in a similar way.
   
   The block displaying other binaries in Sphinx CLI docs has been
   synchronized with the manpage template.
   Previously, the current binary was displayed also. This patch gets rid
   of the unwanted trailing comma there too.
   
   Finally, the CLI executables list in the manpage template now reuses
   the same variable as the RST template that doesn't need any
   post-processing in Jinja2.
   Before, it was already used in the RST template so this patch aligns
   both templates to use the same logic as they got out-of-sync over time.
   
   PR ansible#80450.
   (cherry picked from commit a84b3a4)
   
   Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com>

   

   webknjaz authored and mattclay committed Jul 31, 2023
   Configuration menu

   • View commit details
   • Copy full SHA for c614281
   • Browse repository at this point

   Copy the full SHA

   c614281 View commit details

   Browse the repository at this point in the history