About ROM Library (IDFGH-8759)

[nopnop2002]

Answers checklist.

• I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
• I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
• I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

I used ESP-IDF V5.1 to compile the code below.

#include <stdio.h>
#include <string.h>
#include "rom/miniz.h"
#include "rom/ets_sys.h"
#include "rom/tjpgd.h"
#include "rom/md5_hash.h"

void app_main()
{
    uint8_t buf[64];
    memset(buf, 0, sizeof(buf));
    mz_crc32(MZ_CRC32_INIT, (const mz_uint8 *)(buf), 4);
}

For some reason, only miniz is a warning.

$ idf.py --version
ESP-IDF v5.1-dev-1840-gaad600c9ca

$ idf.py set-target esp32

$ idf.py build

    7 | #warning "{target}/rom/miniz.h is deprecated, please use (#include "miniz.h") instead"
      |  ^~

Reference:
#10177

[gm-jiang]

@nopnop2002 please use #include "miniz.h" instead of #include "rom/miniz.h"

[nopnop2002]

@gm-jiang

#include "miniz.h" is not a warning.

I wonder why only miniz becomes a warning.

[gm-jiang]

@nopnop2002 Since this is a small breaking change that we moved esp_rom/include/{target}/rom/miniz.h to esp_rom/include/miniz.h . In case the user outside has already used rom/miniz.h or esp32/rom/miniz.h, we put a warning code in original miniz.h for notice that changes.

#warning "{target}/rom/miniz.h is deprecated, please use (#include "miniz.h") instead"
#include "../../miniz.h"

[nopnop2002]

@gm-jiang

small breaking change

Thank you.