-
Notifications
You must be signed in to change notification settings - Fork 43
Modify: documentation and usage info #455
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add more descriptive program usage cleanup pointer usage add comments part of #187
/docs/index.md iccV5DspObsToV4Dsp/readme.md
Add description to docs/index.md Update Readme.md in the tool directory Cleanup source and usage text a little bit. Partial fix for #186
Cleanup Spelling fixes. Remove incomplete sentence fragment.
All apps should now refer to the project wide CMake instructions.
Add description for 2 apps that were missing. Add more detail to iccDumpProfile Many of these entries could be cleaned up - but we need to decide what gets documented at the top level, and what is documented in per-app README.md files.
xsscx
approved these changes
Jan 7, 2026
Member
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maintainer Repro
Wed Jan 7 01:04:16 AM UTC 2026
Get PR455
git clone https://github.com/InternationalColorConsortium/iccDEV.git
cd iccDEV/Build
git fetch origin pull/455/head:pr-455
git checkout pr-455
git rev-parse HEAD && git show --no-patch --oneline
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_INSTALL_PREFIX="$HOME/.local" -DCMAKE_BUILD_TYPE=Debug -Wno-dev -DCMAKE_CXX_FLAGS="-g -fsanitize=address,undefined -fno-sanitize=leak -fno-omit-frame-pointer -Wall" -DENABLE_TOOLS=ON -DENABLE_STATIC_LIBS=ON -DENABLE_SHARED_LIBS=ON Cmake > cmake.log 2>&1
make -j32
cd ../Testing/
echo "=== Updating PATH ==="
for d in ../Build/Tools/*; do
[ -d "$d" ] && export PATH="$(realpath "$d"):$PATH"
done
Expected Output
git rev-parse HEAD && git show --no-patch --oneline
95a0465
95a0465 (HEAD -> pr-455, origin/issue-187) more updates for documentation of command line apps
iccApplySearch
Usage 1: iccApplySearch -cfg config_file_path
Where config_file_path is a json formatted ICC profile application configuration file
Usage 2: iccApplySearch {-debugcalc} data_file_path encoding[:precision[:digits]] interpolation {-ENV:tag value} profile1_path intent1 {{-ENV:tag value} middle_profile_path mid_intent} {-ENV:tag value} profile2_path intent2 -INIT init_intent2 {pcc_path1 weight1 ...}
Built with IccProfLib version 2.3.1.2
For final_data_encoding:
0 - icEncodeValue (converts to/from lab encoding when samples=3)
1 - icEncodePercent
2 - icEncodeUnitFloat (may clip to 0.0 to 1.0)
3 - icEncodeFloat
4 - icEncode8Bit
5 - icEncode16Bit
6 - icEncode16BitV2
FmtPrecision - formatting for # of digits after decimal (default=4)
FmtDigits - formatting for total # of digits (default=5+FmtPrecision)
For interpolation:
0 - Linear
1 - Tetrahedral
For init_intent/intent1/intent2/mid_intent:
0 - Perceptual
1 - Relative
2 - Saturation
3 - Absolute
10 + Intent - without D2Bx/B2Dx
40 + Intent - with BPC
90 + Intent - Colorimetric Only
100 + Intent - Spectral Only
+10000 - Use V5 sub-profile if present
iccV5DspObsToV4Dsp
Usage: iccV5DspObsToV4Dsp inputV5.icc inputObserverV5.icc outputV4.icc
Convert an ICCVersion5 display and observer to ICCVersion4 display profile,
allowing version5 profiles to be used by legacy applications.
inputV5.icc: input version5 display profile
inputObserverV5.icc: input version5 observer profile
outputV4.icc: output version4 display profile
Built with IccProfLib version 2.3.1.2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix spelling, bad characters, etc.
Improve usage information in some apps.
Remove obsolete build instructions
Remove obsolete (and incomplete) README.txt
Make more of the documentation match the code.
Fixes #186 #187
Pull Request Checklist