Skip to contentSkip to conversation

canokey: documentation fixes

PATCH New Hongren (Zenithal) Zheng 1 participant 3 messages Jun 12, 2023

lore
Share & tools
lore
#0 lore raw

cover canokey: documentation fixes

This patch series updates the documentation for canokey in QEMU.

Kraxel, could you please pass these patches? I still do not get my gpg key signed. Hopefully I could meet some QEMU maintainers soon and then I can send a PULL.

The following patch also needs to be passed.
https://lore.kernel.org/qemu-devel/ZE5z+2WbvVpTa82H@Sun/

Thanks,

Hongren (Zenithal) Zheng (2):
docs/system/devices/canokey: fix recursive cloning docs/system/devices/canokey: update implementations and web console

 docs/system/devices/canokey.rst | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
Signature · 1 line
2.37.2
#1 lore raw

PATCH 1/2 docs/system/devices/canokey: fix recursive cloning

canokey-qemu contains submodules so it needs
recursive cloning

---
 docs/system/devices/canokey.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/system/devices/canokey.rst +1 -1
index cfa6186e48..5492e6792c 100644
@@ -53,7 +53,7 @@ libcanokey-qemu is required to use CanoKey QEMU.
 
 .. code-block:: shell
 
-    git clone https://github.com/canokeys/canokey-qemu
+    git clone --recursive https://github.com/canokeys/canokey-qemu
     mkdir canokey-qemu/build
     pushd canokey-qemu/build
 
Signature · 1 line
2.37.2
#2 lore raw

PATCH 2/2 docs/system/devices/canokey: update implementations and web console

In reply to Hongren (Zenithal) Zheng

An nRF52 implementation and a new web console was introduced.

The old web console is hosted in a different URL now.

---
 docs/system/devices/canokey.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
docs/system/devices/canokey.rst +6 -3
index 5492e6792c..9b8f404fe8 100644
@@ -18,6 +18,7 @@ including both hardware implementions and virtual cards:
 
 * CanoKey STM32 [4]_
 * CanoKey Pigeon [5]_
+* CanoKey nRF52 [6]_
 * (virt-card) CanoKey USB/IP
 * (virt-card) CanoKey FunctionFS
 
@@ -100,7 +101,7 @@ and find CanoKey QEMU there:
     $ lsusb
     Bus 001 Device 002: ID 20a0:42d4 Clay Logic CanoKey QEMU
 
-You may setup the key as guided in [6]_. The console for the key is at [7]_.
+You may setup the key as guided in [7]_. The console for the key is at [8]_ or [9]_.
 
 Debugging
 =========
@@ -154,5 +155,7 @@ References
 .. [3] `<https://github.com/canokeys/canokey-core>`_
 .. [4] `<https://github.com/canokeys/canokey-stm32>`_
 .. [5] `<https://github.com/canokeys/canokey-pigeon>`_
-.. [6] `<https://docs.canokeys.org/>`_
-.. [7] `<https://console.canokeys.org/>`_
+.. [6] `<https://github.com/canokeys/canokey-nrf52>`_
+.. [7] `<https://docs.canokeys.org/>`_
+.. [8] `<https://console.canokeys.org/>`_
+.. [9] `<https://console-legacy.canokeys.org/>`_
Signature · 1 line
2.37.2