€•®8Œsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œ translations”Œ LanguagesNode”“”)”}”(hhh]”(hŒ pending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ'/translations/zh_CN/gpu/nova/guidelines”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ'/translations/zh_TW/gpu/nova/guidelines”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ'/translations/it_IT/gpu/nova/guidelines”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ'/translations/ja_JP/gpu/nova/guidelines”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ'/translations/ko_KR/gpu/nova/guidelines”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ'/translations/sp_SP/gpu/nova/guidelines”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ*SPDX-License-Identifier: (GPL-2.0+ OR MIT)”h]”hŒ*SPDX-License-Identifier: (GPL-2.0+ OR MIT)”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ xml:space”Œpreserve”uh1h¡hhhžhhŸŒA/var/lib/git/docbuild/linux/Documentation/gpu/nova/guidelines.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ Guidelines”h]”hŒ Guidelines”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒ paragraph”“”)”}”(hŒ\This document describes the general project guidelines that apply to nova-core and nova-drm.”h]”hŒ\This document describes the general project guidelines that apply to nova-core and nova-drm.”…””}”(hhËhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhµ)”}”(hhh]”(hº)”}”(hŒLanguage”h]”hŒLanguage”…””}”(hhÜhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hhÙhžhhŸh³h K ubhÊ)”}”(hŒÔThe Nova project uses the Rust programming language. In this context, all rules of the Rust for Linux project as documented in :doc:`../../rust/general-information` apply. Additionally, the following rules apply.”h]”(hŒThe Nova project uses the Rust programming language. In this context, all rules of the Rust for Linux project as documented in ”…””}”(hhêhžhhŸNh Nubh)”}”(hŒ%:doc:`../../rust/general-information`”h]”hŒinline”“”)”}”(hhôh]”hŒ../../rust/general-information”…””}”(hhøhžhhŸNh Nubah}”(h]”h ]”(Œxref”Œstd”Œstd-doc”eh"]”h$]”h&]”uh1höhhòubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”Œgpu/nova/guidelines”Œ refdomain”jŒreftype”Œdoc”Œ refexplicit”‰Œrefwarn”ˆŒ reftarget”Œ../../rust/general-information”uh1hhŸh³h K hhêubhŒ0 apply. Additionally, the following rules apply.”…””}”(hhêhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K hhÙhžhubhŒ bullet_list”“”)”}”(hhh]”(hŒ list_item”“”)”}”(hŒXUnless technically necessary otherwise (e.g. uAPI), any driver code is written in Rust. ”h]”hÊ)”}”(hŒWUnless technically necessary otherwise (e.g. uAPI), any driver code is written in Rust.”h]”hŒWUnless technically necessary otherwise (e.g. uAPI), any driver code is written in Rust.”…””}”(hj,hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj(ubah}”(h]”h ]”h"]”h$]”h&]”uh1j&hj#hžhhŸh³h Nubj')”}”(hŒÊUnless technically necessary, unsafe Rust code must be avoided. In case of technical necessity, unsafe code should be isolated in a separate component providing a safe API for other driver code to use. ”h]”hÊ)”}”(hŒÉUnless technically necessary, unsafe Rust code must be avoided. In case of technical necessity, unsafe code should be isolated in a separate component providing a safe API for other driver code to use.”h]”hŒÉUnless technically necessary, unsafe Rust code must be avoided. In case of technical necessity, unsafe code should be isolated in a separate component providing a safe API for other driver code to use.”…””}”(hjDhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj@ubah}”(h]”h ]”h"]”h$]”h&]”uh1j&hj#hžhhŸh³h Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1j!hŸh³h KhhÙhžhubhµ)”}”(hhh]”(hº)”}”(hŒStyle”h]”hŒStyle”…””}”(hjchžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj`hžhhŸh³h KubhÊ)”}”(hŒcAll rules of the Rust for Linux project as documented in :doc:`../../rust/coding-guidelines` apply.”h]”(hŒ9All rules of the Rust for Linux project as documented in ”…””}”(hjqhžhhŸNh Nubh)”}”(hŒ#:doc:`../../rust/coding-guidelines`”h]”h÷)”}”(hj{h]”hŒ../../rust/coding-guidelines”…””}”(hj}hžhhŸNh Nubah}”(h]”h ]”(jŒstd”Œstd-doc”eh"]”h$]”h&]”uh1höhjyubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”jŒ refdomain”j‡Œreftype”Œdoc”Œ refexplicit”‰Œrefwarn”ˆjŒ../../rust/coding-guidelines”uh1hhŸh³h KhjqubhŒ apply.”…””}”(hjqhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj`hžhubhÊ)”}”(hŒœFor a submit checklist, please also see the `Rust for Linux Submit checklist addendum `_.”h]”(hŒ,For a submit checklist, please also see the ”…””}”(hj£hžhhŸNh NubhŒ reference”“”)”}”(hŒo`Rust for Linux Submit checklist addendum `_”h]”hŒ(Rust for Linux Submit checklist addendum”…””}”(hj­hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œname”Œ(Rust for Linux Submit checklist addendum”Œrefuri”ŒAhttps://rust-for-linux.com/contributing#submit-checklist-addendum”uh1j«hj£ubhŒtarget”“”)”}”(hŒD ”h]”h}”(h]”Œ(rust-for-linux-submit-checklist-addendum”ah ]”h"]”Œ(rust for linux submit checklist addendum”ah$]”h&]”Œrefuri”j¾uh1j¿Œ referenced”Khj£ubhŒ.”…””}”(hj£hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj`hžhubeh}”(h]”Œstyle”ah ]”h"]”Œstyle”ah$]”h&]”uh1h´hhÙhžhhŸh³h Kubeh}”(h]”Œlanguage”ah ]”h"]”Œlanguage”ah$]”h&]”uh1h´hh¶hžhhŸh³h K ubhµ)”}”(hhh]”(hº)”}”(hŒ Documentation”h]”hŒ Documentation”…””}”(hjìhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjéhžhhŸh³h K#ubhÊ)”}”(hŒìThe availability of proper documentation is essential in terms of scalability, accessibility for new contributors and maintainability of a project in general, but especially for a driver running as complex hardware as Nova is targeting.”h]”hŒìThe availability of proper documentation is essential in terms of scalability, accessibility for new contributors and maintainability of a project in general, but especially for a driver running as complex hardware as Nova is targeting.”…””}”(hjúhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K%hjéhžhubhÊ)”}”(hŒOHence, adding documentation of any kind is very much encouraged by the project.”h]”hŒOHence, adding documentation of any kind is very much encouraged by the project.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K)hjéhžhubhÊ)”}”(hŒ2Besides that, there are some minimum requirements.”h]”hŒ2Besides that, there are some minimum requirements.”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K+hjéhžhubj")”}”(hhh]”(j')”}”(hXEvery non-private structure needs at least a brief doc comment explaining the semantical sense of the structure, as well as potential locking and lifetime requirements. It is encouraged to have the same minimum documentation for non-trivial private structures. ”h]”hÊ)”}”(hXEvery non-private structure needs at least a brief doc comment explaining the semantical sense of the structure, as well as potential locking and lifetime requirements. It is encouraged to have the same minimum documentation for non-trivial private structures.”h]”hXEvery non-private structure needs at least a brief doc comment explaining the semantical sense of the structure, as well as potential locking and lifetime requirements. It is encouraged to have the same minimum documentation for non-trivial private structures.”…””}”(hj+hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K-hj'ubah}”(h]”h ]”h"]”h$]”h&]”uh1j&hj$hžhhŸh³h Nubj')”}”(hŒžuAPIs must be fully documented with kernel-doc comments; additionally, the semantical behavior must be explained including potential special or corner cases. ”h]”hÊ)”}”(hŒuAPIs must be fully documented with kernel-doc comments; additionally, the semantical behavior must be explained including potential special or corner cases.”h]”hŒuAPIs must be fully documented with kernel-doc comments; additionally, the semantical behavior must be explained including potential special or corner cases.”…””}”(hjChžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K2hj?ubah}”(h]”h ]”h"]”h$]”h&]”uh1j&hj$hžhhŸh³h Nubj')”}”(hŒÖThe APIs connecting the 1st level driver (nova-core) with 2nd level drivers must be fully documented. This includes doc comments, potential locking and lifetime requirements, as well as example code if applicable. ”h]”hÊ)”}”(hŒÕThe APIs connecting the 1st level driver (nova-core) with 2nd level drivers must be fully documented. This includes doc comments, potential locking and lifetime requirements, as well as example code if applicable.”h]”hŒÕThe APIs connecting the 1st level driver (nova-core) with 2nd level drivers must be fully documented. This includes doc comments, potential locking and lifetime requirements, as well as example code if applicable.”…””}”(hj[hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K6hjWubah}”(h]”h ]”h"]”h$]”h&]”uh1j&hj$hžhhŸh³h Nubj')”}”(hŒWAbbreviations must be explained when introduced; terminology must be uniquely defined. ”h]”hÊ)”}”(hŒVAbbreviations must be explained when introduced; terminology must be uniquely defined.”h]”hŒVAbbreviations must be explained when introduced; terminology must be uniquely defined.”…””}”(hjshžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K:hjoubah}”(h]”h ]”h"]”h$]”h&]”uh1j&hj$hžhhŸh³h Nubj')”}”(hŒØRegister addresses, layouts, shift values and masks must be defined properly; unless obvious, the semantical sense must be documented. This only applies if the author is able to obtain the corresponding information. ”h]”hÊ)”}”(hŒ×Register addresses, layouts, shift values and masks must be defined properly; unless obvious, the semantical sense must be documented. This only applies if the author is able to obtain the corresponding information.”h]”hŒ×Register addresses, layouts, shift values and masks must be defined properly; unless obvious, the semantical sense must be documented. This only applies if the author is able to obtain the corresponding information.”…””}”(hj‹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K=hj‡ubah}”(h]”h ]”h"]”h$]”h&]”uh1j&hj$hžhhŸh³h Nubeh}”(h]”h ]”h"]”h$]”h&]”j^j_uh1j!hŸh³h K-hjéhžhubeh}”(h]”Œ documentation”ah ]”h"]”Œ documentation”ah$]”h&]”uh1h´hh¶hžhhŸh³h K#ubhµ)”}”(hhh]”(hº)”}”(hŒAcceptance Criteria”h]”hŒAcceptance Criteria”…””}”(hj°hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj­hžhhŸh³h KBubj")”}”(hhh]”j')”}”(hŒ}Patches must only be applied if reviewed by at least one other person on the mailing list; this also applies for maintainers.”h]”hÊ)”}”(hŒ}Patches must only be applied if reviewed by at least one other person on the mailing list; this also applies for maintainers.”h]”hŒ}Patches must only be applied if reviewed by at least one other person on the mailing list; this also applies for maintainers.”…””}”(hjÅhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KDhjÁubah}”(h]”h ]”h"]”h$]”h&]”uh1j&hj¾hžhhŸh³h Nubah}”(h]”h ]”h"]”h$]”h&]”j^j_uh1j!hŸh³h KDhj­hžhubeh}”(h]”Œacceptance-criteria”ah ]”h"]”Œacceptance criteria”ah$]”h&]”uh1h´hh¶hžhhŸh³h KBubeh}”(h]”Œ guidelines”ah ]”h"]”Œ guidelines”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒ current_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ generator”NŒ datestamp”NŒ source_link”NŒ source_url”NŒ toc_backlinks”Œentry”Œfootnote_backlinks”KŒ sectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒ strip_classes”NŒ report_level”KŒ halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ traceback”ˆŒinput_encoding”Œ utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jŒerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ id_prefix”hŒauto_id_prefix”Œid”Œ dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ _destination”NŒ _config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒ raw_enabled”KŒline_length_limit”M'Œpep_references”NŒ pep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒ rfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œ smart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ docinfo_xform”KŒsectsubtitle_xform”‰Œ image_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jìjéjæjãjÞjÛjÊjÇjªj§jäjáuŒ nametypes”}”(jì‰jæ‰jÞ‰jʈjª‰jä‰uh}”(jéh¶jãhÙjÛj`jÇjÁj§jéjáj­uŒ footnote_refs”}”Œ citation_refs”}”Œ autofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ footnotes”]”Œ citations”]”Œautofootnote_start”KŒsymbol_footnote_start”KŒ id_counter”Œ collections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œ transformer”NŒ include_log”]”Œ decoration”Nhžhub.