Skip to content

Commit 020135a

Browse files
maje-embrlubos
authored andcommitted
samples: nfc: writable_ndef_msg: Align documentation
The change updates documentation and aligns comments related to the file system. Signed-off-by: Marcin Jelinski <[email protected]>
1 parent a387955 commit 020135a

File tree

4 files changed

+10
-9
lines changed

4 files changed

+10
-9
lines changed

samples/nfc/writable_ndef_msg/README.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,11 @@ In addition, it uses the Type 4 Tag library from `sdk-nrfxlib`_:
110110

111111
It uses the following Zephyr libraries:
112112

113-
* ``include/atomic.h``
114-
* ``include/zephyr.h``
115-
* ``include/device.h``
116-
* ``include/nvs/nvs.h``
113+
* :ref:`zephyr:nvs_api`
114+
* :ref:`zephyr:zms_api`
115+
* :file:`include/zephyr/zephyr.h`
116+
* :file:`include/zephyr/device.h`
117+
117118
* :ref:`GPIO Interface <zephyr:api_peripherals>`
118119

119120
The sample also uses the following secure firmware component:

samples/nfc/writable_ndef_msg/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ int main(void)
126126
printk("Cannot initialize board!\n");
127127
goto fail;
128128
}
129-
/* Initialize NVS. */
129+
/* Initialize storage. */
130130
if (ndef_file_setup() < 0) {
131131
printk("Cannot setup NDEF file!\n");
132132
goto fail;

samples/nfc/writable_ndef_msg/src/ndef_file_m.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
static const uint8_t m_url[] = /**< Default NDEF message: URL "nordicsemi.com". */
3333
{'n', 'o', 'r', 'd', 'i', 'c', 's', 'e', 'm', 'i', '.', 'c', 'o', 'm'};
3434

35-
/* Flash partition for NVS */
35+
/* Flash partition for storage*/
3636
#define FLASH_DEVICE FIXED_PARTITION_DEVICE(storage_partition)
3737
/* Flash block size in bytes */
3838
#define SECTOR_SIZE (DT_PROP(DT_CHOSEN(zephyr_flash), erase_block_size))
@@ -72,7 +72,7 @@ int ndef_file_setup(void)
7272
#endif /* defined(CONFIG_NVS) */
7373

7474
if (err < 0) {
75-
printk("Cannot initialize NVS!\n");
75+
printk("Cannot initialize storage!\n");
7676
}
7777

7878
return err;

samples/nfc/writable_ndef_msg/src/ndef_file_m.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
#include <zephyr/types.h>
2020

2121
/**
22-
* @brief Function for initializing the NVS module.
22+
* @brief Function for initializing the storage module.
2323
*
2424
* @return 0 when module has been set up properly,
2525
* error code otherwise.
@@ -29,7 +29,7 @@ int ndef_file_setup(void);
2929
/**
3030
* @brief Function for updating NDEF message in the flash file.
3131
*
32-
* @details NVS update operation is performed on main loop.
32+
* @details Storage update operation is performed on main loop.
3333
*
3434
* @param buff Pointer to the NDEF message to be stored in flash.
3535
* @param size Size of NDEF message.

0 commit comments

Comments
 (0)