RFE: provide proper name space of the man pages lvl3

[kloczek]

Currently when source tree is configured with --enable-doxygen-man set of generated man pages is with a bit messy names which may clash with other libraries. It wild be good to rearrange all those names to pattern like libkdumpfile-*.3.
Wit that pattern and command line completion will be easy to find exact part of the documentation.

Details

[tkloczko@devel-g2v libkdumpfile-0.4.1]$ ls doc/man/man3/*| sort
doc/man/man3/_addrxlat_buffer.3
doc/man/man3/addrxlat_CAPI.3
doc/man/man3/_addrxlat_cb.3
doc/man/man3/addrxlat_Context.3
doc/man/man3/_addrxlat_ctx.3
doc/man/man3/addrxlat_CustomMethod.3
doc/man/man3/_addrxlat_fulladdr.3
doc/man/man3/addrxlat_FullAddress.3
doc/man/man3/addrxlat.h.3
doc/man/man3/addrxlat_LinearMethod.3
doc/man/man3/_addrxlat_lookup_elem.3
doc/man/man3/addrxlat_LookupMethod.3
doc/man/man3/addrxlat_Map.3
doc/man/man3/_addrxlat_map.3
doc/man/man3/addrxlat_MemoryArrayMethod.3
doc/man/man3/_addrxlat_meth.3
doc/man/man3/addrxlat_Method.3
doc/man/man3/_addrxlat_op_ctl.3
doc/man/man3/addrxlat_Operator.3
doc/man/man3/_addrxlat_opt.3
doc/man/man3/_addrxlat_optval.3
doc/man/man3/addrxlat_PageTableMethod.3
doc/man/man3/_addrxlat_paging_form.3
doc/man/man3/_addrxlat_param.3
doc/man/man3/_addrxlat_param_custom.3
doc/man/man3/_addrxlat_param_linear.3
doc/man/man3/_addrxlat_param_lookup.3
doc/man/man3/_addrxlat_param_memarr.3
doc/man/man3/_addrxlat_param_pgt.3
doc/man/man3/addrxlat_Range.3
doc/man/man3/_addrxlat_range.3
doc/man/man3/addrxlat_Step.3
doc/man/man3/_addrxlat_step.3
doc/man/man3/_addrxlat_sym.3
doc/man/man3/_addrxlat_sys.3
doc/man/man3/addrxlat_System.3
doc/man/man3/arch_ops.3
doc/man/man3/attr_data.3
doc/man/man3/attr_dict.3
doc/man/man3/attr_dir_object.3
doc/man/man3/attr_flags.3
doc/man/man3/attr_hash.3
doc/man/man3/attr_iter_object.3
doc/man/man3/attr_ops.3
doc/man/man3/attr_override.3
doc/man/man3/attr_template.3
doc/man/man3/attr_template_flags.3
doc/man/man3/blob_object.3
doc/man/man3/bmp_object.3
doc/man/man3/cache.3
doc/man/man3/cache_entry.3
doc/man/man3/cache_search.3
doc/man/man3/constdef.3
doc/man/man3/convert_object.3
doc/man/man3/c_pointer_object.3
doc/man/man3/custommeth_object.3
doc/man/man3/derived_attr_def.3
doc/man/man3/devmem_priv.3
doc/man/man3/disk_dump_priv.3
doc/man/man3/elfdump_priv.3
doc/man/man3/fcache.3
doc/man/man3/fcache_chunk.3
doc/man/man3/fcache_entry.3
doc/man/man3/format_ops.3
doc/man/man3/fulladdr_loc.3
doc/man/man3/fulladdr_object.3
doc/man/man3/hlist_head.3
doc/man/man3/hlist_node.3
doc/man/man3/inflight.3
doc/man/man3/_kdump_attr.3
doc/man/man3/_kdump_attr_iter.3
doc/man/man3/_kdump_attr_ref.3
doc/man/man3/_kdump_attr_value.3
doc/man/man3/_kdump_blob.3
doc/man/man3/_kdump_bmp.3
doc/man/man3/kdump_bmp_ops.3
doc/man/man3/_kdump_ctx.3
doc/man/man3/_kdump_errmsg.3
doc/man/man3/kdumpfile_exceptions_AddressTranslationException.3
doc/man/man3/kdumpfile_exceptions_BusyException.3
doc/man/man3/kdumpfile_exceptions_CorruptException.3
doc/man/man3/kdumpfile_exceptions_EOFException.3
doc/man/man3/kdumpfile_exceptions_InvalidException.3
doc/man/man3/kdumpfile_exceptions_KDumpBaseException.3
doc/man/man3/kdumpfile_exceptions_NoDataException.3
doc/man/man3/kdumpfile_exceptions_NoKeyException.3
doc/man/man3/kdumpfile_exceptions_NotImplementedException.3
doc/man/man3/kdumpfile_exceptions_OSErrorException.3
doc/man/man3/kdumpfile.h.3
doc/man/man3/kdumpfile_kdumpfile.3
doc/man/man3/kdumpfile_object.3
doc/man/man3/kdumpfile_views_attr_setview.3
doc/man/man3/kdumpfile_views_attr_view.3
doc/man/man3/kdumpfile_views_attr_viewdict.3
doc/man/man3/kdumpfile_views_attr_viewitems.3
doc/man/man3/kdumpfile_views_attr_viewkeys.3
doc/man/man3/kdumpfile_views_attr_viewvalues.3
doc/man/man3/kdump_shared.3
doc/man/man3/kdump_xlat.3
doc/man/man3/libtoolize.3
doc/man/man3/libtoolize_build_ext.3
doc/man/man3/libtoolize_install_lib.3
doc/man/man3/list_head.3
doc/man/man3/lkcd_priv.3
doc/man/man3/load_segment.3
doc/man/man3/map_object.3
doc/man/man3/md_objects.3
doc/man/man3/memarrmeth_object.3
doc/man/man3/meth_object.3
doc/man/man3/meth_param_object.3
doc/man/man3/mutexattr_t.3
doc/man/man3/mutex_t.3
doc/man/man3/new_utsname.3
doc/man/man3/op_object.3
doc/man/man3/os_init_data.3
doc/man/man3/page_desc.3
doc/man/man3/page_io.3
doc/man/man3/param_loc.3
doc/man/man3/parsed_opts.3
doc/man/man3/pfn2idx.3
doc/man/man3/pfn2idx_map.3
doc/man/man3/pfn2idx_range.3
doc/man/man3/pfn_block.3
doc/man/man3/pfn_rgn.3
doc/man/man3/pgtmeth_object.3
doc/man/man3/phash.3
doc/man/man3/range_object.3
doc/man/man3/read_cache.3
doc/man/man3/read_cache_slot.3
doc/man/man3/read_param.3
doc/man/man3/rwlockattr_t.3
doc/man/man3/rwlock_t.3
doc/man/man3/s390dump_priv.3
doc/man/man3/section.3
doc/man/man3/setup_data.3
doc/man/man3/step_object.3
doc/man/man3/sym_spec.3
doc/man/man3/sys_object.3
doc/man/man3/sys_region.3
doc/man/man3/tag_ctx_object.3
doc/man/man3/test_addrxlat_TestAddressSpace.3
doc/man/man3/test_addrxlat_TestContext.3
doc/man/man3/test_addrxlat_TestCustom.3
doc/man/man3/test_addrxlat_TestFullAddress.3
doc/man/man3/test_addrxlat_TestMap.3
doc/man/man3/test_addrxlat_TestMethod.3
doc/man/man3/test_addrxlat_TestOperator.3
doc/man/man3/test_addrxlat_TestRange.3
doc/man/man3/test_addrxlat_TestStep.3
doc/man/man3/test_addrxlat_TestSystem.3
doc/man/man3/test_addrxlat_TestTranslation.3
doc/man/man3/threads.3
doc/man/man3/timeval_32.3
doc/man/man3/timeval_64.3
doc/man/man3/vtop_kphysnote.3
doc/man/man3/xen_crash_info_32.3
doc/man/man3/xen_crash_info_64.3
doc/man/man3/xen_crash_info_x86.3
doc/man/man3/xen_crash_info_x86_64.3
doc/man/man3/xen_dumpcore_elfnote_xen_version_32.3
doc/man/man3/xen_dumpcore_elfnote_xen_version_64.3
doc/man/man3/xen_elfnote_header.3
doc/man/man3/xen_p2m.3
doc/man/man3/xlat_alt.3
doc/man/man3/xlat_chain.3

[ptesarik]

A lot of the incorrectly named man pages should now be gone with the removal of legacy Python bindings. Let me have a look into the remaining ones.

[ptesarik]

Hm, the result does not quite match my expectations. I guess I must spend some time learning how man pages are supposed to be generated by Doxygen. 😞

[ptesarik]

After doing a bit of research, I believe there is no way to create usable man pages with Doxygen, and that seems to be the general consensus.

I can see why man pages would be useful for this library, but I don't want to keep man pages separate from code, because such setup tends to get out of sync pretty quickly. Maybe we should replace Doxygen with something else? What should that be?