[PATCH] cpu-supplement: Remove empty index

Chris Johns chrisj at rtems.org
Mon Aug 20 06:15:22 UTC 2018


On 20/08/2018 16:12, Sebastian Huber wrote:
> On 13/08/18 02:01, Chris Johns wrote:
>>> On 10 Aug 2018, at 5:39 pm, Sebastian Huber
>>> <sebastian.huber at embedded-brains.de> wrote:
>>>
>>> Due to the hierarchical structure an index is not absolutely necessary
>>> and an empty index is not helpful.
>> Are there index entries in the doc source that are not being processed?  If so
>> the bug is in the generation and removing this entry may not be a solution.
>>
>> I did want to support indexes when the doc source was ported. HTML may not
>> need them but does PDF benefit?
> 
> grep -r -l 'index::' c-user/ cpu-supplement/
> c-user/dual_ports_memory_manager.rst
> c-user/scheduling_concepts.rst
> c-user/object_services.rst
> c-user/constant_bandwidth_server.rst
> c-user/timespec_helpers.rst
> c-user/key_concepts.rst
> c-user/barrier_manager.rst
> c-user/symmetric_multiprocessing_services.rst
> c-user/multiprocessing.rst
> c-user/stack_bounds_checker.rst
> c-user/red_black_trees.rst
> c-user/configuring_a_system.rst
> c-user/ada_support.rst
> c-user/timer_manager.rst
> c-user/message_manager.rst
> c-user/board_support_packages.rst
> c-user/directive_status_codes.rst
> c-user/rtems_data_types.rst
> c-user/fatal_error.rst
> c-user/task_manager.rst
> c-user/chains.rst
> c-user/overview.rst
> c-user/region_manager.rst
> c-user/linker_sets.rst
> c-user/clock_manager.rst
> c-user/rate_monotonic_manager.rst
> c-user/pci_library.rst
> c-user/semaphore_manager.rst
> c-user/interrupt_manager.rst
> c-user/signal_manager.rst
> c-user/partition_manager.rst
> c-user/initialization.rst
> c-user/user_extensions.rst
> c-user/io_manager.rst
> c-user/event_manager.rst
> c-user/cpu_usage_statistics.rst
> 
> It seems the CPU Supplement doesn't contain index directives.
> 

OK, lets remove the index so it is clear there is no index in the document. how
does that sound?

> The RTEMS Classic API Guide contains index directives, however, the index
> chapter is empty in the PDF
> 
> https://docs.rtems.org/branches/master/c-user.pdf
> 
> and non-empty in the HTML
> 
> https://docs.rtems.org/branches/master/c-user/genindex.html
> 

Thanks for this. I will need to take a look and figure this out.

Chris


More information about the devel mailing list