Skip to content

Update config_reference.markdown#20440

Merged
alalek merged 3 commits intoopencv:masterfrom
parsa-ra:patch-1
Jul 24, 2021
Merged

Update config_reference.markdown#20440
alalek merged 3 commits intoopencv:masterfrom
parsa-ra:patch-1

Conversation

@parsa-ra
Copy link
Copy Markdown
Contributor

@parsa-ra parsa-ra commented Jul 21, 2021

Added description for WITH_CLP build option.

Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on a code under GPL or other license that is incompatible with OpenCV
  • The PR is proposed to proper branch
  • There is reference to original bug report and related work
  • There is accuracy test, performance test and test data in opencv_extra repository, if applicable
    Patch to opencv_extra has the same branch name.
  • The feature is well documented and sample code can be built with the project CMake

Added description for `WITH_CLP` build option.
@asmorkalov asmorkalov added category: documentation Documentation fix or update pr: needs rebase Rebase patch (and squash fixup commits) on the top of target branch and removed pr: needs rebase Rebase patch (and squash fixup commits) on the top of target branch labels Jul 22, 2021
| `OPENCV_CMAKE_HOOKS_DIR` | _empty_ | OpenCV allows to customize configuration process by adding custom hook scripts at each stage and substage. cmake scripts with predefined names located in the directory set by this variable will be included before and after various configuration stages. Examples of file names: _CMAKE_INIT.cmake_, _PRE_CMAKE_BOOTSTRAP.cmake_, _POST_CMAKE_BOOTSTRAP.cmake_, etc.. Other names are not documented and can be found in the project cmake files by searching for the _ocv_cmake_hook_ macro calls. |
| `OPENCV_DUMP_HOOKS_FLOW` | _OFF_ | Enables a debug message print on each cmake hook script call. |

## Thirdparty modules
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to name it "Math Libraries" or something like that. Eigen and LAPACK should be there too.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about Contrib Modules? Since to the best of my knowledge, it's only utilized in opencv_contrib:videostab module. But I agree with the naming for Eigen and LAPACK ...

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add reference to contrib to the option description.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in 79d03fd
There is a bit of an issue though ... can't cross-reference to other sections of the document using anchors. Do Github's markdown engine support id extensions?

Can't cross-reference with anchors to other sections of the markdown file due to the presence of markdown link extension in the form of 
`## Header {#id-of-header}`
@alalek
Copy link
Copy Markdown
Member

alalek commented Jul 24, 2021

Need to fix trailing whitespace issues:

doc/tutorials/introduction/config_reference/config_reference.markdown:592: trailing whitespace.
+## Contrib Modules 

@alalek alalek merged commit 7aa922c into opencv:master Jul 24, 2021
@alalek alalek mentioned this pull request Oct 15, 2021
a-sajjad72 pushed a commit to a-sajjad72/opencv that referenced this pull request Mar 30, 2023
* Update config_reference.markdown

Added description for `WITH_CLP` build option.

* Added extra description

Can't cross-reference with anchors to other sections of the markdown file due to the presence of markdown link extension in the form of 
`## Header {#id-of-header}`

* Fixed trailing space issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category: documentation Documentation fix or update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants