€•“9Œ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ŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ'/translations/pt_BR/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”“”)”}”(hjh]”hŒ../../rust/general-information”…””}”(hj h²hh³Nh´Nubah}”(h]”h ]”(Œxref”Œstd”Œstd-doc”eh"]”h$]”h&]”uh1j hjubah}”(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:hj7h²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.”…””}”(hjXh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhjTubah}”(h]”h ]”h"]”h$]”h&]”uh1j:hj7h²hh³hÇh´Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1j5h³hÇh´Khhíh²hubhÉ)”}”(hhh]”(hÎ)”}”(hŒStyle”h]”hŒStyle”…””}”(hjwh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjth²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 ”…””}”(hj…h²hh³Nh´Nubh)”}”(hŒ#:doc:`../../rust/coding-guidelines`”h]”j )”}”(hjh]”hŒ../../rust/coding-guidelines”…””}”(hj‘h²hh³Nh´Nubah}”(h]”h ]”(jŒstd”Œstd-doc”eh"]”h$]”h&]”uh1j hjubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”j#Œ refdomain”j›Œreftype”Œdoc”Œ refexplicit”‰Œrefwarn”ˆj)Œ../../rust/coding-guidelines”uh1hh³hÇh´Khj…ubhŒ apply.”…””}”(hj…h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khjth²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´Khjth²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”…””}”(hjh²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.”…””}”(hjh²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.”…””}”(hj*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K+hjýh²hubj6)”}”(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:hj8h²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.”…””}”(hjWh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K2hjSubah}”(h]”h ]”h"]”h$]”h&]”uh1j:hj8h²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.”…””}”(hjoh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K6hjkubah}”(h]”h ]”h"]”h$]”h&]”uh1j:hj8h²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.”…””}”(hj‡h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K:hjƒubah}”(h]”h ]”h"]”h$]”h&]”uh1j:hj8h²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:hj8h²hh³hÇh´Nubeh}”(h]”h ]”h"]”h$]”h&]”jrjsuh1j5h³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´KBubj6)”}”(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&]”jrjsuh1j5h³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”}”(jjýjúj÷jòjïjÞjÛj¾j»jøjõuŒ nametypes”}”(j‰jú‰jò‰jÞˆj¾‰jø‰uh}”(jýhÊj÷híjïjtjÛ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.