Rafael Espíndola
2013-May-28 14:06 UTC
[LLVMdev] The system library is gone for a long time.
>> Ideally we would have a >> docs/SystemLibrary.rst that would just says "this library has been >> merged to lib/Support" and docs/SupportLibrary.rst documents whatever >> is in lib/Support. > > > Considering our OS portability layer to be it's own separate thing, even if > it isn't its own lib/* directory is probably a good distinction to make > regardless. And SystemLibrary.rst is well-written and has excellent, focused > content about LLVM's approach to OS portability. > > After thinking about this a bit more, it's not clear to me that it would be > beneficial to include this content into a general page about libSupport, as > that would make it less focused and harder to find. If anything, it would be > "ideal" to put it into a file Portability.rst (or similar), but that's a > marginal benefit anyway since it is already one of the top hits when > searching "llvm portability". We can really easily massage the title and > content (such as referenced file paths), like what happended to > clang/docs/Tooling.rst, which is now "Choosing the Right Interface for Your > Application" <http://clang.llvm.org/docs/Tooling.html>.That is ok. It is the reference to libSystem that is confusing, so making this file about the "portability features in lib/Support" would be great!> -- Sean SilvaCheers, Rafael
I hit upon docs/SystemLibrary.rst today. Is this documentation useful to anyone? Can I delete it? Most of the guidelines seem like common sense: Keeping LLVM Portable, High Level Interface, No Unused Functionality, No Duplicate Implementations, etc. Some are not really true, like "Minimize Soft Errors". We currently propagate a lot of file-related soft errors up as llvm::error_codes. Only a few seem useful to me: Don’t Expose System Headers (basically, no windows.h) and No Virtual Methods. On Tue, May 28, 2013 at 7:06 AM, Rafael Espíndola < rafael.espindola at gmail.com> wrote:> >> Ideally we would have a > >> docs/SystemLibrary.rst that would just says "this library has been > >> merged to lib/Support" and docs/SupportLibrary.rst documents whatever > >> is in lib/Support. > > > > > > Considering our OS portability layer to be it's own separate thing, even > if > > it isn't its own lib/* directory is probably a good distinction to make > > regardless. And SystemLibrary.rst is well-written and has excellent, > focused > > content about LLVM's approach to OS portability. > > > > After thinking about this a bit more, it's not clear to me that it would > be > > beneficial to include this content into a general page about libSupport, > as > > that would make it less focused and harder to find. If anything, it > would be > > "ideal" to put it into a file Portability.rst (or similar), but that's a > > marginal benefit anyway since it is already one of the top hits when > > searching "llvm portability". We can really easily massage the title and > > content (such as referenced file paths), like what happended to > > clang/docs/Tooling.rst, which is now "Choosing the Right Interface for > Your > > Application" <http://clang.llvm.org/docs/Tooling.html>. > > That is ok. It is the reference to libSystem that is confusing, so > making this file about the "portability features in lib/Support" would > be great! > > > -- Sean Silva > > Cheers, > Rafael > _______________________________________________ > llvm-commits mailing list > llvm-commits at cs.uiuc.edu > http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits >-------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20131118/9b906272/attachment.html>
On Mon, Nov 18, 2013 at 8:11 PM, Reid Kleckner <rnk at google.com> wrote:> I hit upon docs/SystemLibrary.rst today. > > Is this documentation useful to anyone? Can I delete it? > > Most of the guidelines seem like common sense: Keeping LLVM Portable, High > Level Interface, No Unused Functionality, No Duplicate Implementations, etc. >They aren't all written down elsewhere, so I oppose removing them. Also, as a general rule, I look with extreme scrutiny at anything that would break the validity of existing URL's.> > Some are not really true, like "Minimize Soft Errors". We currently > propagate a lot of file-related soft errors up as llvm::error_codes. >Please fix that one to describe the current best-practices for error handling. -- Sean Silva> > Only a few seem useful to me: Don’t Expose System Headers (basically, no > windows.h) and No Virtual Methods. > > > On Tue, May 28, 2013 at 7:06 AM, Rafael Espíndola < > rafael.espindola at gmail.com> wrote: > >> >> Ideally we would have a >> >> docs/SystemLibrary.rst that would just says "this library has been >> >> merged to lib/Support" and docs/SupportLibrary.rst documents whatever >> >> is in lib/Support. >> > >> > >> > Considering our OS portability layer to be it's own separate thing, >> even if >> > it isn't its own lib/* directory is probably a good distinction to make >> > regardless. And SystemLibrary.rst is well-written and has excellent, >> focused >> > content about LLVM's approach to OS portability. >> > >> > After thinking about this a bit more, it's not clear to me that it >> would be >> > beneficial to include this content into a general page about >> libSupport, as >> > that would make it less focused and harder to find. If anything, it >> would be >> > "ideal" to put it into a file Portability.rst (or similar), but that's a >> > marginal benefit anyway since it is already one of the top hits when >> > searching "llvm portability". We can really easily massage the title and >> > content (such as referenced file paths), like what happended to >> > clang/docs/Tooling.rst, which is now "Choosing the Right Interface for >> Your >> > Application" <http://clang.llvm.org/docs/Tooling.html>. >> >> That is ok. It is the reference to libSystem that is confusing, so >> making this file about the "portability features in lib/Support" would >> be great! >> >> > -- Sean Silva >> >> Cheers, >> Rafael >> >> _______________________________________________ >> llvm-commits mailing list >> llvm-commits at cs.uiuc.edu >> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits >> > >-------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20131118/60088bc2/attachment.html>
Reasonably Related Threads
- [LLVMdev] The system library is gone for a long time.
- [LLVMdev] The system library is gone for a long time.
- [LLVMdev] The system library is gone for a long time.
- [LLVMdev] The system library is gone for a long time.
- [LLVMdev] The system library is gone for a long time.