Skip to content
This repository was archived by the owner on Feb 28, 2024. It is now read-only.

Deprecate library #118

Merged
merged 5 commits into from
Feb 27, 2024
Merged

Deprecate library #118

merged 5 commits into from
Feb 27, 2024

Conversation

leonardocavagnis
Copy link
Collaborator

@leonardocavagnis leonardocavagnis commented Jan 12, 2024 •
edited
Loading

Adding deprecation note to README, library.properties and examples.

This library will be replaced and no longer maintained.

Please,
@sebromero check if everything is fine
@per1234 check if I've followed all the necessary steps for deprecating a library correctly

Thanks! ✌️

UPDATE
Migration guide here.

per1234
per1234 suggested changes Jan 12, 2024
View reviewed changes
@github-actions GitHub Actions
Copy link

Memory usage change @ 719b570

Board flash % RAM for global variables %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A
Click for full report table
Board examples/Analog_Out
flash		 % examples/Analog_Out
RAM for global variables		 % examples/Analog_input/Analog_input_0_10V
flash		 % examples/Analog_input/Analog_input_0_10V
RAM for global variables		 % examples/Analog_input/Analog_input_4_20mA
flash		 % examples/Analog_input/Analog_input_4_20mA
RAM for global variables		 % examples/Analog_input/Analog_input_NTC
flash		 % examples/Analog_input/Analog_input_NTC
RAM for global variables		 % examples/CAN/ReadCan
flash		 % examples/CAN/ReadCan
RAM for global variables		 % examples/CAN/WriteCan
flash		 % examples/CAN/WriteCan
RAM for global variables		 % examples/Digital_output
flash		 % examples/Digital_output
RAM for global variables		 % examples/Digital_programmable/CombinedIOExpander
flash		 % examples/Digital_programmable/CombinedIOExpander
RAM for global variables		 % examples/Digital_programmable/Digital_input
flash		 % examples/Digital_programmable/Digital_input
RAM for global variables		 % examples/Digital_programmable/GPIO_programmable
flash		 % examples/Digital_programmable/GPIO_programmable
RAM for global variables		 % examples/Encoders
flash		 % examples/Encoders
RAM for global variables		 % examples/Ethernet
flash		 % examples/Ethernet
RAM for global variables		 % examples/RS232
flash		 % examples/RS232
RAM for global variables		 % examples/RS485_fullduplex
flash		 % examples/RS485_fullduplex
RAM for global variables		 % examples/RS485_halfduplex
flash		 % examples/RS485_halfduplex
RAM for global variables		 % examples/RTC
flash		 % examples/RTC
RAM for global variables		 % examples/RTC_Alarm
flash		 % examples/RTC_Alarm
RAM for global variables		 % examples/Temp_probes_RTD
flash		 % examples/Temp_probes_RTD
RAM for global variables		 % examples/Temp_probes_Thermocouples
flash		 % examples/Temp_probes_Thermocouples
RAM for global variables		 % examples/USB_host
flash		 % examples/USB_host
RAM for global variables		 %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
Click for full report CSV 
Board,examples/Analog_Out<br>flash,%,examples/Analog_Out<br>RAM for global variables,%,examples/Analog_input/Analog_input_0_10V<br>flash,%,examples/Analog_input/Analog_input_0_10V<br>RAM for global variables,%,examples/Analog_input/Analog_input_4_20mA<br>flash,%,examples/Analog_input/Analog_input_4_20mA<br>RAM for global variables,%,examples/Analog_input/Analog_input_NTC<br>flash,%,examples/Analog_input/Analog_input_NTC<br>RAM for global variables,%,examples/CAN/ReadCan<br>flash,%,examples/CAN/ReadCan<br>RAM for global variables,%,examples/CAN/WriteCan<br>flash,%,examples/CAN/WriteCan<br>RAM for global variables,%,examples/Digital_output<br>flash,%,examples/Digital_output<br>RAM for global variables,%,examples/Digital_programmable/CombinedIOExpander<br>flash,%,examples/Digital_programmable/CombinedIOExpander<br>RAM for global variables,%,examples/Digital_programmable/Digital_input<br>flash,%,examples/Digital_programmable/Digital_input<br>RAM for global variables,%,examples/Digital_programmable/GPIO_programmable<br>flash,%,examples/Digital_programmable/GPIO_programmable<br>RAM for global variables,%,examples/Encoders<br>flash,%,examples/Encoders<br>RAM for global variables,%,examples/Ethernet<br>flash,%,examples/Ethernet<br>RAM for global variables,%,examples/RS232<br>flash,%,examples/RS232<br>RAM for global variables,%,examples/RS485_fullduplex<br>flash,%,examples/RS485_fullduplex<br>RAM for global variables,%,examples/RS485_halfduplex<br>flash,%,examples/RS485_halfduplex<br>RAM for global variables,%,examples/RTC<br>flash,%,examples/RTC<br>RAM for global variables,%,examples/RTC_Alarm<br>flash,%,examples/RTC_Alarm<br>RAM for global variables,%,examples/Temp_probes_RTD<br>flash,%,examples/Temp_probes_RTD<br>RAM for global variables,%,examples/Temp_probes_Thermocouples<br>flash,%,examples/Temp_probes_Thermocouples<br>RAM for global variables,%,examples/USB_host<br>flash,%,examples/USB_host<br>RAM for global variables,%
arduino:mbed_portenta:envie_m7,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A

@leonardocavagnis @per1234
Update library.properties (remove html link)
f0c30b5 
Co-authored-by: per1234 <accounts@perglass.com>
@github-actions GitHub Actions
Copy link

Memory usage change @ f0c30b5

Board flash % RAM for global variables %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A
Click for full report table
Board examples/Analog_Out
flash		 % examples/Analog_Out
RAM for global variables		 % examples/Analog_input/Analog_input_0_10V
flash		 % examples/Analog_input/Analog_input_0_10V
RAM for global variables		 % examples/Analog_input/Analog_input_4_20mA
flash		 % examples/Analog_input/Analog_input_4_20mA
RAM for global variables		 % examples/Analog_input/Analog_input_NTC
flash		 % examples/Analog_input/Analog_input_NTC
RAM for global variables		 % examples/CAN/ReadCan
flash		 % examples/CAN/ReadCan
RAM for global variables		 % examples/CAN/WriteCan
flash		 % examples/CAN/WriteCan
RAM for global variables		 % examples/Digital_output
flash		 % examples/Digital_output
RAM for global variables		 % examples/Digital_programmable/CombinedIOExpander
flash		 % examples/Digital_programmable/CombinedIOExpander
RAM for global variables		 % examples/Digital_programmable/Digital_input
flash		 % examples/Digital_programmable/Digital_input
RAM for global variables		 % examples/Digital_programmable/GPIO_programmable
flash		 % examples/Digital_programmable/GPIO_programmable
RAM for global variables		 % examples/Encoders
flash		 % examples/Encoders
RAM for global variables		 % examples/Ethernet
flash		 % examples/Ethernet
RAM for global variables		 % examples/RS232
flash		 % examples/RS232
RAM for global variables		 % examples/RS485_fullduplex
flash		 % examples/RS485_fullduplex
RAM for global variables		 % examples/RS485_halfduplex
flash		 % examples/RS485_halfduplex
RAM for global variables		 % examples/RTC
flash		 % examples/RTC
RAM for global variables		 % examples/RTC_Alarm
flash		 % examples/RTC_Alarm
RAM for global variables		 % examples/Temp_probes_RTD
flash		 % examples/Temp_probes_RTD
RAM for global variables		 % examples/Temp_probes_Thermocouples
flash		 % examples/Temp_probes_Thermocouples
RAM for global variables		 % examples/USB_host
flash		 % examples/USB_host
RAM for global variables		 %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
Click for full report CSV 
Board,examples/Analog_Out<br>flash,%,examples/Analog_Out<br>RAM for global variables,%,examples/Analog_input/Analog_input_0_10V<br>flash,%,examples/Analog_input/Analog_input_0_10V<br>RAM for global variables,%,examples/Analog_input/Analog_input_4_20mA<br>flash,%,examples/Analog_input/Analog_input_4_20mA<br>RAM for global variables,%,examples/Analog_input/Analog_input_NTC<br>flash,%,examples/Analog_input/Analog_input_NTC<br>RAM for global variables,%,examples/CAN/ReadCan<br>flash,%,examples/CAN/ReadCan<br>RAM for global variables,%,examples/CAN/WriteCan<br>flash,%,examples/CAN/WriteCan<br>RAM for global variables,%,examples/Digital_output<br>flash,%,examples/Digital_output<br>RAM for global variables,%,examples/Digital_programmable/CombinedIOExpander<br>flash,%,examples/Digital_programmable/CombinedIOExpander<br>RAM for global variables,%,examples/Digital_programmable/Digital_input<br>flash,%,examples/Digital_programmable/Digital_input<br>RAM for global variables,%,examples/Digital_programmable/GPIO_programmable<br>flash,%,examples/Digital_programmable/GPIO_programmable<br>RAM for global variables,%,examples/Encoders<br>flash,%,examples/Encoders<br>RAM for global variables,%,examples/Ethernet<br>flash,%,examples/Ethernet<br>RAM for global variables,%,examples/RS232<br>flash,%,examples/RS232<br>RAM for global variables,%,examples/RS485_fullduplex<br>flash,%,examples/RS485_fullduplex<br>RAM for global variables,%,examples/RS485_halfduplex<br>flash,%,examples/RS485_halfduplex<br>RAM for global variables,%,examples/RTC<br>flash,%,examples/RTC<br>RAM for global variables,%,examples/RTC_Alarm<br>flash,%,examples/RTC_Alarm<br>RAM for global variables,%,examples/Temp_probes_RTD<br>flash,%,examples/Temp_probes_RTD<br>RAM for global variables,%,examples/Temp_probes_Thermocouples<br>flash,%,examples/Temp_probes_Thermocouples<br>RAM for global variables,%,examples/USB_host<br>flash,%,examples/USB_host<br>RAM for global variables,%
arduino:mbed_portenta:envie_m7,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A

@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels Jan 15, 2024
per1234
per1234 suggested changes Jan 15, 2024
View reviewed changes
per1234
per1234 approved these changes Jan 16, 2024
View reviewed changes
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @leonardocavagnis!

sebromero
sebromero suggested changes Jan 18, 2024
View reviewed changes
Copy link
Contributor

@sebromero sebromero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two small suggestions, otherwise looks good.

@leonardocavagnis @sebromero
Update README.md: warning notation
a7a19c0 
Co-authored-by: Sebastian Romero <s.romero.zh@gmail.com>
@github-actions GitHub Actions
Copy link

Memory usage change @ a7a19c0

Board flash % RAM for global variables %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A
Click for full report table
Board examples/Analog_Out
flash		 % examples/Analog_Out
RAM for global variables		 % examples/Analog_input/Analog_input_0_10V
flash		 % examples/Analog_input/Analog_input_0_10V
RAM for global variables		 % examples/Analog_input/Analog_input_4_20mA
flash		 % examples/Analog_input/Analog_input_4_20mA
RAM for global variables		 % examples/Analog_input/Analog_input_NTC
flash		 % examples/Analog_input/Analog_input_NTC
RAM for global variables		 % examples/CAN/ReadCan
flash		 % examples/CAN/ReadCan
RAM for global variables		 % examples/CAN/WriteCan
flash		 % examples/CAN/WriteCan
RAM for global variables		 % examples/Digital_output
flash		 % examples/Digital_output
RAM for global variables		 % examples/Digital_programmable/CombinedIOExpander
flash		 % examples/Digital_programmable/CombinedIOExpander
RAM for global variables		 % examples/Digital_programmable/Digital_input
flash		 % examples/Digital_programmable/Digital_input
RAM for global variables		 % examples/Digital_programmable/GPIO_programmable
flash		 % examples/Digital_programmable/GPIO_programmable
RAM for global variables		 % examples/Encoders
flash		 % examples/Encoders
RAM for global variables		 % examples/Ethernet
flash		 % examples/Ethernet
RAM for global variables		 % examples/RS232
flash		 % examples/RS232
RAM for global variables		 % examples/RS485_fullduplex
flash		 % examples/RS485_fullduplex
RAM for global variables		 % examples/RS485_halfduplex
flash		 % examples/RS485_halfduplex
RAM for global variables		 % examples/RTC
flash		 % examples/RTC
RAM for global variables		 % examples/RTC_Alarm
flash		 % examples/RTC_Alarm
RAM for global variables		 % examples/Temp_probes_RTD
flash		 % examples/Temp_probes_RTD
RAM for global variables		 % examples/Temp_probes_Thermocouples
flash		 % examples/Temp_probes_Thermocouples
RAM for global variables		 % examples/USB_host
flash		 % examples/USB_host
RAM for global variables		 %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
Click for full report CSV 
Board,examples/Analog_Out<br>flash,%,examples/Analog_Out<br>RAM for global variables,%,examples/Analog_input/Analog_input_0_10V<br>flash,%,examples/Analog_input/Analog_input_0_10V<br>RAM for global variables,%,examples/Analog_input/Analog_input_4_20mA<br>flash,%,examples/Analog_input/Analog_input_4_20mA<br>RAM for global variables,%,examples/Analog_input/Analog_input_NTC<br>flash,%,examples/Analog_input/Analog_input_NTC<br>RAM for global variables,%,examples/CAN/ReadCan<br>flash,%,examples/CAN/ReadCan<br>RAM for global variables,%,examples/CAN/WriteCan<br>flash,%,examples/CAN/WriteCan<br>RAM for global variables,%,examples/Digital_output<br>flash,%,examples/Digital_output<br>RAM for global variables,%,examples/Digital_programmable/CombinedIOExpander<br>flash,%,examples/Digital_programmable/CombinedIOExpander<br>RAM for global variables,%,examples/Digital_programmable/Digital_input<br>flash,%,examples/Digital_programmable/Digital_input<br>RAM for global variables,%,examples/Digital_programmable/GPIO_programmable<br>flash,%,examples/Digital_programmable/GPIO_programmable<br>RAM for global variables,%,examples/Encoders<br>flash,%,examples/Encoders<br>RAM for global variables,%,examples/Ethernet<br>flash,%,examples/Ethernet<br>RAM for global variables,%,examples/RS232<br>flash,%,examples/RS232<br>RAM for global variables,%,examples/RS485_fullduplex<br>flash,%,examples/RS485_fullduplex<br>RAM for global variables,%,examples/RS485_halfduplex<br>flash,%,examples/RS485_halfduplex<br>RAM for global variables,%,examples/RTC<br>flash,%,examples/RTC<br>RAM for global variables,%,examples/RTC_Alarm<br>flash,%,examples/RTC_Alarm<br>RAM for global variables,%,examples/Temp_probes_RTD<br>flash,%,examples/Temp_probes_RTD<br>RAM for global variables,%,examples/Temp_probes_Thermocouples<br>flash,%,examples/Temp_probes_Thermocouples<br>RAM for global variables,%,examples/USB_host<br>flash,%,examples/USB_host<br>RAM for global variables,%
arduino:mbed_portenta:envie_m7,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A

@leonardocavagnis leonardocavagnis merged commit a2a31d3 into arduino-libraries:master Feb 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
2 more reviewers

@sebromero sebromero sebromero requested changes

@per1234 per1234 per1234 approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@leonardocavagnis @sebromero @per1234
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy