Skip to content

Update broken links in readme and comments #1110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ application projects. That way you will have the correct FreeRTOS source files
included, and the correct include paths configured. Once a demo application is
building and executing you can remove the demo application files, and start to
add in your own application source files. See the
[FreeRTOS Kernel Quick Start Guide](https://www.FreeRTOS.org/FreeRTOS-quick-start-guide.html)
[FreeRTOS Kernel Quick Start Guide](https://www.freertos.org/Documentation/01-FreeRTOS-quick-start/01-Beginners-guide/02-Quick-start-guide)
for detailed instructions and other useful links.

Additionally, for FreeRTOS kernel feature information refer to the
[Developer Documentation](https://www.FreeRTOS.org/features.html),
and [API Reference](https://www.FreeRTOS.org/a00106.html).
[Developer Documentation](https://www.freertos.org/Documentation/02-Kernel/02-Kernel-features/00-Developer-docs),
and [API Reference](https://www.freertos.org/Documentation/02-Kernel/04-API-references/01-Task-creation/00-TaskHandle).

Also for contributing and creating a Pull Request please refer to
[the instructions here](.github/CONTRIBUTING.md#contributing-via-pull-request).
Expand Down
2 changes: 1 addition & 1 deletion examples/cmake_example/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* This is a simple main that will start the FreeRTOS-Kernel and run a periodic task
* that only delays if compiled with the template port, this project will do nothing.
* For more information on getting started please look here:
* https://freertos.org/FreeRTOS-quick-start-guide.html
* https://www.freertos.org/Documentation/01-FreeRTOS-quick-start/01-Beginners-guide/02-Quick-start-guide
*/

/* FreeRTOS includes. */
Expand Down
4 changes: 2 additions & 2 deletions include/queue.h
Original file line number Diff line number Diff line change
Expand Up @@ -1645,7 +1645,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION;
* or semaphores contained in the set is in a state where a queue read or
* semaphore take operation would be successful.
*
* Note 1: See the documentation on https://www.FreeRTOS.org/RTOS-queue-sets.html
* Note 1: See the documentation on https://www.freertos.org/Documentation/02-Kernel/04-API-references/07-Queue-sets/00-RTOS-queue-sets
* for reasons why queue sets are very rarely needed in practice as there are
* simpler methods of blocking on multiple objects.
*
Expand Down Expand Up @@ -1742,7 +1742,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION;
* See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this
* function.
*
* Note 1: See the documentation on https://www.FreeRTOS.org/RTOS-queue-sets.html
* Note 1: See the documentation on https://www.freertos.org/Documentation/02-Kernel/04-API-references/07-Queue-sets/00-RTOS-queue-sets
* for reasons why queue sets are very rarely needed in practice as there are
* simpler methods of blocking on multiple objects.
*
Expand Down
2 changes: 1 addition & 1 deletion list.c
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ void vListInsert( List_t * const pxList,
{
/* *** NOTE ***********************************************************
* If you find your application is crashing here then likely causes are
* listed below. In addition see https://www.FreeRTOS.org/FAQHelp.html for
* listed below. In addition see https://www.freertos.org/Why-FreeRTOS/FAQs for
* more tips, and ensure configASSERT() is defined!
* https://www.FreeRTOS.org/a00110.html#configASSERT
*
Expand Down
4 changes: 2 additions & 2 deletions portable/ARMv8M/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
2 changes: 1 addition & 1 deletion portable/CCS/ARM_CM3/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -669,7 +669,7 @@ void vPortSetupTimerInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
2 changes: 1 addition & 1 deletion portable/CCS/ARM_CM4F/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,7 @@ void vPortSetupTimerInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
2 changes: 1 addition & 1 deletion portable/GCC/ARM_CM0/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1288,7 +1288,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM23/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM23_NTZ/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM3/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ BaseType_t xPortStartScheduler( void )
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -801,7 +801,7 @@ __attribute__( ( weak ) ) void vPortSetupTimerInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM33/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM33_NTZ/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM35P/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM35P_NTZ/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM3_MPU/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,7 @@ BaseType_t xPortStartScheduler( void )
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -1462,7 +1462,7 @@ void vPortStoreTaskMPUSettings( xMPU_SETTINGS * xMPUSettings,
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM4F/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ BaseType_t xPortStartScheduler( void )
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -886,7 +886,7 @@ static void vPortEnableVFP( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM4_MPU/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -853,7 +853,7 @@ BaseType_t xPortStartScheduler( void )
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -1605,7 +1605,7 @@ void vPortStoreTaskMPUSettings( xMPU_SETTINGS * xMPUSettings,
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM55/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM55_NTZ/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM7/r0p1/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ BaseType_t xPortStartScheduler( void )
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -876,7 +876,7 @@ static void vPortEnableVFP( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM85/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
4 changes: 2 additions & 2 deletions portable/GCC/ARM_CM85_NTZ/non_secure/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,7 @@ BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
*
* Assertion failures here indicate incorrect installation of the
* FreeRTOS handlers. For help installing the FreeRTOS handlers, see
* https://www.FreeRTOS.org/FAQHelp.html.
* https://www.freertos.org/Why-FreeRTOS/FAQs.
*
* Systems with a configurable address for the interrupt vector table
* can also encounter assertion failures or even system faults here if
Expand Down Expand Up @@ -2041,7 +2041,7 @@ BaseType_t xPortIsInsideInterrupt( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
}

Expand Down
2 changes: 1 addition & 1 deletion portable/IAR/ARM_CA9/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,7 @@ uint32_t ulPortSetInterruptMask( void )
*
* The following links provide detailed information:
* https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
* https://www.FreeRTOS.org/FAQHelp.html */
* https://www.freertos.org/Why-FreeRTOS/FAQs */
configASSERT( portICCRPR_RUNNING_PRIORITY_REGISTER >= ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) );

/* Priority grouping: The interrupt controller (GIC) allows the bits
Expand Down
Loading
Loading