llvm icon indicating copy to clipboard operation
llvm copied to clipboard

Manual pages for dpc++ and sycl-ls

Open frenchwr opened this issue 1 month ago • 5 comments

Hello, how do I generate man pages for DPC++ (clang* compiler command) and sycl-ls?

frenchwr avatar Dec 02 '25 15:12 frenchwr

Hi, I don't think we provide any man pages for the open-source version, although I may be wrong. Not sure who is the right person to answer this. Maybe @intel/dpcpp-doc-reviewers could help here?

KornevNikita avatar Dec 03 '25 11:12 KornevNikita

I'm creating debian packages for Ubuntu and the man pages are something the archive admins will want to see.

frenchwr avatar Dec 03 '25 14:12 frenchwr

I don't think it's something we have intentionally maintained, but since the compiler is simply Clang with extra functionality, it should be possible to generate the man pages the same way as you would for upstream LLVM clang.

For sycl-ls we don't currently have any man page documentation written. If you want, we can convert this to a request for sycl-ls man documentation (and intel/llvm clang if something is missing compared to upstream clang) but I cannot speak to the timeframe for when it would be addressed.

steffenlarsen avatar Dec 04 '25 14:12 steffenlarsen

it should be possible to generate the man pages the same way as you would for upstream LLVM clang.

Do you know if it's automated in the sense that flags/options that are specific to DPC++ will be included?

If you want, we can convert this to a request for sycl-ls man documentation (and intel/llvm clang if something is missing compared to upstream clang) but I cannot speak to the timeframe for when it would be addressed.

That would be great...at least that way we have something to point to showing it's being worked on.

frenchwr avatar Dec 04 '25 15:12 frenchwr

Do you know if it's automated in the sense that flags/options that are specific to DPC++ will be included?

From what I can tell, the documentation is static and based on clang/docs/CommandGuide/clang.rst. We would have to add a selection of intel/llvm's flags and options to it, though we might have to be selective given how few of clang's options are documented in there.

steffenlarsen avatar Dec 04 '25 15:12 steffenlarsen