Skip to content

Commit 0f7bf1c

Browse files
committed
doc: Update minimum nasm recommendation and details
Change-Id: Icb113242c0ab7f3c75af3e65a8d519511f4ed4c3 Signed-off-by: Greg Tucker <[email protected]>
1 parent 393f69f commit 0f7bf1c

File tree

2 files changed

+28
-5
lines changed

2 files changed

+28
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Building ISA-L
3333
* Optional: Building with autotools requires autoconf/automake packages.
3434

3535
x86_64:
36-
* Assembler: nasm v2.11.01 or later (nasm v2.13 or better suggested for building in AVX512 support)
37-
or yasm version 1.2.0 or later.
36+
* Assembler: nasm. Version 2.15 or later suggested (other versions of nasm and
37+
yasm may build but with limited function [support.](doc/build.md)
3838
* Compiler: gcc, clang, icc or VC compiler.
3939

4040
aarch64:

doc/build.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,32 @@
11
# ISA-L Build Details
22

3-
For x86-64 builds it is highly recommended to get an up-to-date version of
3+
## Build tools
4+
5+
NASM: For x86-64 builds it is highly recommended to get an up-to-date version of
46
[nasm] that can understand the latest instruction sets. Building with an older
5-
version is usually possible but the library may lack some function versions for
6-
the best performance.
7+
assembler version is often possible but the library may lack some function
8+
versions for the best performance. For example, as a minimum, nasm v2.11.01 or
9+
yasm 1.2.0 can be used to build a limited functionality library but it will not
10+
include any function versions with AVX2, AVX512, or optimizations for many
11+
processors before the assembler's build. The configure or make tools can run
12+
tests to check the assembler's knowledge of new instructions and change build
13+
defines. For autoconf builds, check the output of configure for full nasm
14+
support as it includes the following lines.
15+
16+
checking for nasm... yes
17+
checking for modern nasm... yes
18+
checking for optional nasm AVX512 support... yes
19+
checking for additional nasm AVX512 support... yes
20+
21+
If an appropriate nasm is not available from your distro, it is simple to build
22+
from source or download an executable from [nasm].
23+
24+
git clone --depth=10 https://github.com/netwide-assembler/nasm
25+
cd nasm
26+
./autogen.sh
27+
./configure
28+
make
29+
sudo make install
730

831
## Windows Build Environment Details
932

0 commit comments

Comments
 (0)