Skip to content

Commit

Permalink
Update 'Snappy' package documentation and example
Browse files Browse the repository at this point in the history
  • Loading branch information
chfast committed Mar 28, 2019
1 parent 1fc143e commit 9ff90ac
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 16 deletions.
25 changes: 9 additions & 16 deletions docs/packages/pkg/Snappy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,13 @@
Snappy
======

.. warning::

This page is a template and contains no real information.
Please send pull request with real description.

- `__FIXME__ Official <https://__FIXME__>`__
- `__FIXME__ Hunterized <https://github.com/hunter-packages/__FIXME__>`__
- `__FIXME__ Example <https://github.com/ruslo/hunter/blob/master/examples/__FIXME__/CMakeLists.txt>`__
- Available since `__FIXME__ vX.Y.Z <https://github.com/ruslo/hunter/releases/tag/vX.Y.Z>`__
- Added by `__FIXME__ <https://github.com/__FIXME__>`__ (`__FIXME__ pr-N <https://github.com/ruslo/hunter/pull/N>`__)

.. code-block:: cmake
hunter_add_package(__FIXME__)
find_package(__FIXME__ CONFIG REQUIRED)
target_link_libraries(foo __FIXME__::__FIXME__)
- `Official <https://google.github.io/snappy>`__
- `Example <https://github.com/ruslo/hunter/blob/master/examples/Snappy/CMakeLists.txt>`__
- Available since `v0.19.68 <https://github.com/ruslo/hunter/releases/tag/v0.19.68>`__
- Added by `Paweł Bylica <https://github.com/chfast>`__ (`pr-949 <https://github.com/ruslo/hunter/pull/949>`__)

.. literalinclude:: /../examples/sleef/CMakeLists.txt
:language: cmake
:start-after: # DOCUMENTATION_START {
:end-before: # DOCUMENTATION_END }

3 changes: 3 additions & 0 deletions examples/Snappy/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ include("../common.cmake")

project(download-snappy)

# DOCUMENTATION_START {
hunter_add_package(Snappy)
find_package(Snappy CONFIG REQUIRED)

add_executable(snappy_compress_test main.cpp)
target_link_libraries(snappy_compress_test Snappy::snappy)
# DOCUMENTATION_END }

0 comments on commit 9ff90ac

Please sign in to comment.