gh-libusb/hidapi
Watch
1
0
Fork
You've already forked hidapi
 0
Code Issues 58 Pull requests 18 Releases 13 Wiki Activity

Doc: Fix target documentation #640

Merged
cmorty merged 1 commit from fix-doc into master 2023-11-17 05:45:47 -06:00
Conversation 8 Commits 1 Files changed 1 +1 -1
cmorty commented 2023-11-16 04:55:55 -06:00 (Migrated from github.com)
No description provided.
Youw (Migrated from github.com) reviewed 2023-11-16 04:55:55 -06:00
Youw (Migrated from github.com) reviewed 2023-11-16 10:37:00 -06:00
BUILD.cmake.md
@ -216,3 +216,3 @@
Available CMake targets after `add_subdirectory(hidapi)` _are the same as in case of [standalone build](#standalone-package-build)_, and a few additional ones:
- `hidapi_include` - the interface library; `hidapi::hidapi` is an alias of it;
- `hidapi_include` - the interface library; `hidapi::include` is an alias of it;
- `hidapi_winapi` - library target on Windows; `hidapi::winapi` is an alias of it;
Youw (Migrated from github.com) commented 2023-11-16 10:37:00 -06:00

thanks

thanks
Youw (Migrated from github.com) reviewed 2023-11-16 10:38:30 -06:00
BUILD.cmake.md
@ -214,7 +214,7 @@ This is done to let the host project's developer decide what is important (what
In a _subdirectory build_, even if not set, those variables remain unchanged, so a host project's developer has a full control over the HIDAPI build configuration.
Youw (Migrated from github.com) commented 2023-11-16 10:38:30 -06:00

this statement is deceptive

  1. this is a list of targets as explicitly stated above
  2. The original statement is true: 1, 2
this statement is deceptive 1) this is a list of _targets_ as explicitly stated above 2) The original statement is true: [1](https://github.com/libusb/hidapi/blob/9b507edd8ab66bd8c16cbd9379f6c26ca72d6465/windows/CMakeLists.txt#L44), [2](https://github.com/libusb/hidapi/blob/9b507edd8ab66bd8c16cbd9379f6c26ca72d6465/mac/CMakeLists.txt#L32)
cmorty (Migrated from github.com) reviewed 2023-11-16 10:46:47 -06:00
BUILD.cmake.md
@ -214,7 +214,7 @@ This is done to let the host project's developer decide what is important (what
In a _subdirectory build_, even if not set, those variables remain unchanged, so a host project's developer has a full control over the HIDAPI build configuration.
cmorty (Migrated from github.com) commented 2023-11-16 10:46:46 -06:00

You are right, I actually missed that. Wouldn't it make sense to remove those two and declare them at the same place as hidapi::hidapi for all targets?

You are right, I actually missed that. Wouldn't it make sense to remove those two and declare them at the same place as `hidapi::hidapi` for all targets?
Youw (Migrated from github.com) reviewed 2023-11-16 11:00:43 -06:00
BUILD.cmake.md
@ -214,7 +214,7 @@ This is done to let the host project's developer decide what is important (what
In a _subdirectory build_, even if not set, those variables remain unchanged, so a host project's developer has a full control over the HIDAPI build configuration.
Youw (Migrated from github.com) commented 2023-11-16 11:00:43 -06:00

not nesessary
per-platform files has per-platform definitions
documentation is in one place
we should be good as is

not nesessary per-platform files has per-platform definitions documentation is in one place we should be good as is
cmorty (Migrated from github.com) reviewed 2023-11-17 01:17:40 -06:00
BUILD.cmake.md
@ -214,7 +214,7 @@ This is done to let the host project's developer decide what is important (what
In a _subdirectory build_, even if not set, those variables remain unchanged, so a host project's developer has a full control over the HIDAPI build configuration.
cmorty (Migrated from github.com) commented 2023-11-17 01:17:40 -06:00

Ok. The advantage of cleaning things up would be that the sentence would be:

`hidapi` [...] an alias of `hidapi::hidapi`

but probably one shouldn't use those targets anyway. :)

Ok. The advantage of cleaning things up would be that the sentence would be: ``` `hidapi` [...] an alias of `hidapi::hidapi` ``` but probably one shouldn't use those targets anyway. :)
Youw (Migrated from github.com) reviewed 2023-11-17 05:44:37 -06:00
BUILD.cmake.md
@ -214,7 +214,7 @@ This is done to let the host project's developer decide what is important (what
In a _subdirectory build_, even if not set, those variables remain unchanged, so a host project's developer has a full control over the HIDAPI build configuration.
Youw (Migrated from github.com) commented 2023-11-17 05:44:37 -06:00

hidapi [...] an alias of hidapi::hidapi

That would be a strong but technically invalid statement as of right now.

> `hidapi` [...] an alias of `hidapi::hidapi` That would be a strong but technically invalid statement as of right now.
Youw (Migrated from github.com) reviewed 2023-11-17 05:45:40 -06:00
BUILD.cmake.md
@ -214,7 +214,7 @@ This is done to let the host project's developer decide what is important (what
In a _subdirectory build_, even if not set, those variables remain unchanged, so a host project's developer has a full control over the HIDAPI build configuration.
Youw (Migrated from github.com) commented 2023-11-17 05:45:39 -06:00

probably one shouldn't use those targets anyway. :)

That's exactly why that target is added for compatibility cases only.
I'll consider removing it completely for v1.0

> probably one shouldn't use those targets anyway. :) That's exactly why that target is added for compatibility cases only. I'll consider removing it completely for v1.0
Sign in to join this conversation.
Reviewers
No reviewers
Youw
Labels
Clear labels   
3rdparty
3rd-party related issue/question

  
Android
Android OS related

  
API
API change, Version 1 stuff

  
Author does not respond

   
bsd
FreeBSD, NetBSD, OpenBSD, etc

  
bug
Something isn't working

  
build system/CI
Anything related to building the project or running on CI

  
ci-virtual-device
Run the virtual HID device CI jobs (Windows driver + libusb raw-gadget)

  
CMake
Related to CMake build system

  
Contributions Welcome
Any external help is welcome

  
Core
Related to common codes like hidapi.h

  
dependencies
Pull requests that update a dependency file

  
device-specific
Issues/PRs related to a specific device

  
documentation
Improvements or additions to documentation

  
don't_merge
Don't merge this PR as is

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
Example
Related to hidtest or new examples

  
Haiku
Related to Haiku OS (using libusb backend)

  
hidraw
Related to Linux/hidraw backend

  
hotplug
Related to hotplug

  
info required
Need more input from PR/issue author

  
invalid
Not a HIDAPI issue

  
libusb
Related to libusb backend

  
macOS
Related to macOS backend

  
Misc
Typo, whitespace, etc.

  
Not an issue

   
question
Information is requested

  
Release
Related to new release

  
Test
Related to built-in test (not hidtest)

  
Test GUI
Related to a Test GUI application

  
Windows
Related to Windows backend

  
wontfix
This will not be worked on

No labels
3rdparty
Android
API
Author does not respond
bsd
bug
build system/CI
ci-virtual-device
CMake
Contributions Welcome
Core
dependencies
device-specific
documentation
don't_merge
duplicate
enhancement
Example
Haiku
hidraw
hotplug
info required
invalid
libusb
macOS
Misc
Not an issue
question
Release
Test
Test GUI
Windows
wontfix
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
gh-libusb/hidapi!640
No description provided.