aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGravatar Ryan <fauxpark@gmail.com>2020-07-16 15:49:18 +1000
committerGravatar GitHub <noreply@github.com>2020-07-16 15:49:18 +1000
commit72d327054744fa142469dbb5406ad61f5ad0a302 (patch)
treebbdf7937d6837ffdd323391f3dde2e9538fa447e /docs
parent92d0a71af71973ac3f80398ed4f7f61dd97733b3 (diff)
downloadqmk_firmware-72d327054744fa142469dbb5406ad61f5ad0a302.tar.gz
Remove `DESCRIPTION` (#9732)
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md2
-rw-r--r--docs/es/hardware_avr.md3
-rw-r--r--docs/hardware_avr.md3
-rw-r--r--docs/ja/config_options.md2
-rw-r--r--docs/ja/hardware_avr.md3
5 files changed, 3 insertions, 10 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 21c9972e0..81a3b4b61 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -43,8 +43,6 @@ This is a C header file that is one of the first things included, and will persi
* generally who/whatever brand produced the board
* `#define PRODUCT Board`
* the name of the keyboard
-* `#define DESCRIPTION a keyboard`
- * a short description of what the keyboard is
* `#define MATRIX_ROWS 5`
* the number of rows in your keyboard's matrix
* `#define MATRIX_COLS 15`
diff --git a/docs/es/hardware_avr.md b/docs/es/hardware_avr.md
index 4236292a1..2ecf78d66 100644
--- a/docs/es/hardware_avr.md
+++ b/docs/es/hardware_avr.md
@@ -67,7 +67,7 @@ El archivo `config.h` es donde configuras el hardware y el conjunto de caracterÃ
En la parte superior de `config.h` encontrarás ajustes relacionados con USB. Estos controlan la apariencia de tu teclado en el Sistema Operativo. Si no tienes una buena razón para cambiar debes dejar el `VENDOR_ID` como `0xFEED`. Para el `PRODUCT_ID` debes seleccionar un número que todavía no esté en uso.
-Cambia las líneas de `MANUFACTURER`, `PRODUCT`, y `DESCRIPTION` para reflejar con precisión tu teclado.
+Cambia las líneas de `MANUFACTURER` y `PRODUCT` para reflejar con precisión tu teclado.
```c
#define VENDOR_ID 0xFEED
@@ -75,7 +75,6 @@ Cambia las líneas de `MANUFACTURER`, `PRODUCT`, y `DESCRIPTION` para reflejar c
#define DEVICE_VER 0x0001
#define MANUFACTURER Tú
#define PRODUCT mi_teclado_fantastico
-#define DESCRIPTION Un teclado personalizado
```
?> Windows y macOS mostrarán el `MANUFACTURER` y `PRODUCT` en la lista de dispositivos USB. `lsusb` en Linux toma estos de la lista mantenida por el [Repositorio de ID USB](http://www.linux-usb.org/usb-ids.html) por defecto. `lsusb -v` mostrará los valores reportados por el dispositivo, y también están presentes en los registros del núcleo después de conectarlo.
diff --git a/docs/hardware_avr.md b/docs/hardware_avr.md
index 697c55d2a..2c0f2e9a1 100644
--- a/docs/hardware_avr.md
+++ b/docs/hardware_avr.md
@@ -67,7 +67,7 @@ The `config.h` file is where you configure the hardware and feature set for your
At the top of the `config.h` you'll find USB related settings. These control how your keyboard appears to the Operating System. If you don't have a good reason to change you should leave the `VENDOR_ID` as `0xFEED`. For the `PRODUCT_ID` you should pick a number that is not yet in use.
-Do change the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` lines to accurately reflect your keyboard.
+Do change the `MANUFACTURER` and `PRODUCT` lines to accurately reflect your keyboard.
```c
#define VENDOR_ID 0xFEED
@@ -75,7 +75,6 @@ Do change the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` lines to accurately r
#define DEVICE_VER 0x0001
#define MANUFACTURER You
#define PRODUCT my_awesome_keyboard
-#define DESCRIPTION A custom keyboard
```
?> Windows and macOS will display the `MANUFACTURER` and `PRODUCT` in the list of USB devices. `lsusb` on Linux instead takes these from the list maintained by the [USB ID Repository](http://www.linux-usb.org/usb-ids.html) by default. `lsusb -v` will show the values reported by the device, and they are also present in kernel logs after plugging it in.
diff --git a/docs/ja/config_options.md b/docs/ja/config_options.md
index 9e0dd7147..55ee2cfbe 100644
--- a/docs/ja/config_options.md
+++ b/docs/ja/config_options.md
@@ -48,8 +48,6 @@ QMK ã§ã®å…¨ã¦ã®åˆ©ç”¨å¯èƒ½ãªè¨­å®šã«ã¯ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆãŒã‚ã‚Šã¾ã™ã€‚ã
* 一般的ã«ã€èª°ã‚‚ã—ãã¯ã©ã®ãƒ–ランドãŒãƒœãƒ¼ãƒ‰ã‚’作æˆã—ãŸã‹
* `#define PRODUCT Board`
* キーボードã®åå‰
-* `#define DESCRIPTION a keyboard`
- * キーボードã®ç°¡å˜ãªèª¬æ˜Ž
* `#define MATRIX_ROWS 5`
* キーボードã®ãƒžãƒˆãƒªãƒƒã‚¯ã‚¹ã®è¡Œã®æ•°
* `#define MATRIX_COLS 15`
diff --git a/docs/ja/hardware_avr.md b/docs/ja/hardware_avr.md
index fecbfd71f..0cba943c1 100644
--- a/docs/ja/hardware_avr.md
+++ b/docs/ja/hardware_avr.md
@@ -73,7 +73,7 @@ or open the directory in your favourite text editor.
`config.h` ã®å…ˆé ­ã«ã¯ USB ã«é–¢ã™ã‚‹è¨­å®šãŒã‚ã‚Šã¾ã™ã€‚ã“れらã¯ã‚­ãƒ¼ãƒœãƒ¼ãƒ‰ãŒ OS ã‹ã‚‰ã©ã®ã‚ˆã†ã«è¦‹ãˆã‚‹ã‹ã‚’制御ã—ã¦ã„ã¾ã™ã€‚変更ã™ã‚‹ç†ç”±ãŒãªã„å ´åˆã¯ã€`VENDOR_ID` ã‚’ `0xFEED` ã®ã¾ã¾ã«ã—ã¦ãŠãå¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚`PRODUCT_ID` ã«ã¯ã¾ã ä½¿ç”¨ã•ã‚Œã¦ã„ãªã„番å·ã‚’é¸ã°ãªã‘ã‚Œã°ã„ã‘ã¾ã›ã‚“。
-`MANUFACTURER`〠`PRODUCT`〠`DESCRIPTION` をキーボードã«ã‚ã£ãŸè¨­å®šã«å¤‰æ›´ã—ã¾ã™ã€‚
+`MANUFACTURER`〠`PRODUCT` をキーボードã«ã‚ã£ãŸè¨­å®šã«å¤‰æ›´ã—ã¾ã™ã€‚
```c
#define VENDOR_ID 0xFEED
@@ -81,7 +81,6 @@ or open the directory in your favourite text editor.
#define DEVICE_VER 0x0001
#define MANUFACTURER You
#define PRODUCT my_awesome_keyboard
-#define DESCRIPTION A custom keyboard
```
?> Windows ã‚„ macOS ã§ã¯ã€`MANUFACTURER` 㨠`PRODUCT` ㌠USBデãƒã‚¤ã‚¹ã®ãƒªã‚¹ãƒˆã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚Linux 上㮠`lsusb` ã§ã¯ã€ä»£ã‚ã‚Šã«ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã§ [USB ID Repository](http://www.linux-usb.org/usb-ids.html) ã«ã‚ˆã£ã¦ç¶­æŒã•ã‚Œã¦ã„るリストã‹ã‚‰ã“れらをå–å¾—ã—ã¾ã™ã€‚`lsusb -v` を使用ã™ã‚‹ã¨ãƒ‡ãƒã‚¤ã‚¹ã‹ã‚‰ç¤ºã•ã‚ŒãŸå€¤ã‚’表示ã—ã¾ã™ã€‚ã¾ãŸã€æŽ¥ç¶šã—ãŸã¨ãã®ã‚«ãƒ¼ãƒãƒ«ãƒ­ã‚°ã«ã‚‚表示ã•ã‚Œã¾ã™ã€‚