[all-commits] [llvm/llvm-project] aef399: [IRBuilder][NFC] Clarify docs on fadd/fmul reductions

[Fraser Cormack via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: aef39925214c1212ca28e0ea7893cd5f82fafab7
      https://github.com/llvm/llvm-project/commit/aef39925214c1212ca28e0ea7893cd5f82fafab7
  Author: Fraser Cormack <fraser at codeplay.com>
  Date:   2021-08-10 (Tue, 10 Aug 2021)

  Changed paths:
    M llvm/include/llvm/IR/IRBuilder.h

  Log Message:
  -----------
  [IRBuilder][NFC] Clarify docs on fadd/fmul reductions

This patch aims to clear up any confusion in documentation for the
fadd/fmul reduction creation APIs with regards to the sequential and
unordered variations without changing the APIs themselves.

The scalar accumulator value isn't only used for sequential reduction
intrinsics so the impliciation to the contrary was dropped. Then I
thought it useful to make clear that the API always creates a sequential
reduction. And lastly a note to users on how it is possible to transform
the resulting reduction into an unordered one.

Reviewed By: craig.topper

Differential Revision: https://reviews.llvm.org/D107753