aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrank Barchard <fbarchard@chromium.org>2018-09-04 11:52:18 -0700
committerCommit Bot <commit-bot@chromium.org>2018-09-04 19:45:41 +0000
commit9a07219dc8fbf2b77e390d16bd24809444838a91 (patch)
tree48c2a73a34d46e4bdee7ef70c61bfb53dccf8f37 /docs
parent759188cf02925dd195f56b983e18b743bb51dfd3 (diff)
downloadlibyuv-9a07219dc8fbf2b77e390d16bd24809444838a91.tar.gz
Documentation update for GYP and envionment variables
Bug: libyuv:816, libyuv:804 Change-Id: I73a6960b2cc6f3ca31c43c44ccd8b01f5e9e7013 Test" Untested Reviewed-on: https://chromium-review.googlesource.com/1205053 Reviewed-by: Nico Weber <thakis@chromium.org> Commit-Queue: Frank Barchard <fbarchard@chromium.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/environment_variables.md20
-rw-r--r--docs/getting_started.md13
2 files changed, 23 insertions, 10 deletions
diff --git a/docs/environment_variables.md b/docs/environment_variables.md
index c28d83e7..cd8159ad 100644
--- a/docs/environment_variables.md
+++ b/docs/environment_variables.md
@@ -6,7 +6,10 @@ For test purposes, environment variables can be set to control libyuv behavior.
By default the cpu is detected and the most advanced form of SIMD is used. But you can disable instruction sets selectively, or completely, falling back on C code. Set the variable to 1 to disable the specified instruction set.
+## All CPUs
LIBYUV_DISABLE_ASM
+
+## Intel CPUs
LIBYUV_DISABLE_X86
LIBYUV_DISABLE_SSE2
LIBYUV_DISABLE_SSSE3
@@ -14,12 +17,25 @@ By default the cpu is detected and the most advanced form of SIMD is used. But
LIBYUV_DISABLE_SSE42
LIBYUV_DISABLE_AVX
LIBYUV_DISABLE_AVX2
- LIBYUV_DISABLE_AVX512BW
LIBYUV_DISABLE_ERMS
LIBYUV_DISABLE_FMA3
- LIBYUV_DISABLE_MSA
+ LIBYUV_DISABLE_F16C
+ LIBYUV_DISABLE_AVX512BW
+ LIBYUV_DISABLE_AVX512VL
+ LIBYUV_DISABLE_AVX512VBMI
+ LIBYUV_DISABLE_AVX512VBMI2
+ LIBYUV_DISABLE_AVX512VBITALG
+ LIBYUV_DISABLE_AVX512VPOPCNTDQ
+ LIBYUV_DISABLE_GFNI
+
+## ARM CPUs
+
LIBYUV_DISABLE_NEON
+## MIPS CPUs
+ LIBYUV_DISABLE_MSA
+ LIBYUV_DISABLE_MMI
+
# Test Width/Height/Repeat
The unittests default to a small image (128x72) to run fast. This can be set by environment variable to test a specific resolutions.
diff --git a/docs/getting_started.md b/docs/getting_started.md
index afa8a899..4426b606 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -27,7 +27,7 @@ Then you'll get a .gclient file like:
},
];
-For iOS add `;target_os=['ios'];` to your OSX .gclient and run `GYP_DEFINES="OS=ios" gclient sync.`
+For iOS add `;target_os=['ios'];` to your OSX .gclient and run `gclient sync.`
Browse the Git reprository: https://chromium.googlesource.com/libyuv/libyuv/+/master
@@ -48,11 +48,8 @@ For Android add `;target_os=['android'];` to your Linux .gclient
Then run:
- export GYP_DEFINES="OS=android"
gclient sync
-The sync will generate native build files for your environment using gyp (Windows: Visual Studio, OSX: XCode, Linux: make). This generation can also be forced manually: `gclient runhooks`
-
To get just the source (not buildable):
git clone https://chromium.googlesource.com/libyuv/libyuv
@@ -135,8 +132,8 @@ ia32
mips
- gn gen out/Release "--args=is_debug=false target_os=\"android\" target_cpu=\"mips64el\" mips_arch_variant=\"r6\" mips_use_msa=true is_component_build=true is_clang=true"
- gn gen out/Debug "--args=is_debug=true target_os=\"android\" target_cpu=\"mips64el\" mips_arch_variant=\"r6\" mips_use_msa=true is_component_build=true is_clang=true"
+ gn gen out/Release "--args=is_debug=false target_os=\"android\" target_cpu=\"mips64el\" mips_arch_variant=\"r6\" mips_use_msa=true is_component_build=true"
+ gn gen out/Debug "--args=is_debug=true target_os=\"android\" target_cpu=\"mips64el\" mips_arch_variant=\"r6\" mips_use_msa=true is_component_build=true"
ninja -v -C out/Debug libyuv_unittest
ninja -v -C out/Release libyuv_unittest
@@ -182,8 +179,8 @@ Running test with C code:
mips
- gn gen out/Release "--args=is_debug=false target_os=\"linux\" target_cpu=\"mips64el\" mips_arch_variant=\"loongson3\" mips_use_mmi=true is_component_build=false is_clang=false use_sysroot=false use_gold=false"
- gn gen out/Debug "--args=is_debug=true target_os=\"linux\" target_cpu=\"mips64el\" mips_arch_variant=\"loongson3\" mips_use_mmi=true is_component_build=false is_clang=false use_sysroot=false use_gold=false"
+ gn gen out/Release "--args=is_debug=false target_os=\"linux\" target_cpu=\"mips64el\" mips_arch_variant=\"loongson3\" mips_use_mmi=true is_component_build=false use_sysroot=false use_gold=false"
+ gn gen out/Debug "--args=is_debug=true target_os=\"linux\" target_cpu=\"mips64el\" mips_arch_variant=\"loongson3\" mips_use_mmi=true is_component_build=false use_sysroot=false use_gold=false"
ninja -v -C out/Debug libyuv_unittest
ninja -v -C out/Release libyuv_unittest