€•Zk      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ4/translations/zh_CN/filesystems/bcachefs/CodingStyle”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/zh_TW/filesystems/bcachefs/CodingStyle”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/it_IT/filesystems/bcachefs/CodingStyle”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/ja_JP/filesystems/bcachefs/CodingStyle”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/ko_KR/filesystems/bcachefs/CodingStyle”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ4/translations/sp_SP/filesystems/bcachefs/CodingStyle”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒN/var/lib/git/docbuild/linux/Documentation/filesystems/bcachefs/CodingStyle.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒbcachefs coding style”h]”hŒbcachefs coding style”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒ	paragraph”“”)”}”(hX  Good development is like gardening, and codebases are our gardens. Tend to them
every day; look for little things that are out of place or in need of tidying.
A little weeding here and there goes a long way; don't wait until things have
spiraled out of control.”h]”hX  Good development is like gardening, and codebases are our gardens. Tend to them
every day; look for little things that are out of place or in need of tidying.
A little weeding here and there goes a long way; donâ€™t wait until things have
spiraled out of control.”…””}”(hhËhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒThings don't always have to be perfect - nitpicking often does more harm than
good. But appreciate beauty when you see it - and let people know.”h]”hŒ’Things donâ€™t always have to be perfect - nitpicking often does more harm than
good. But appreciate beauty when you see it - and let people know.”…””}”(hhÙhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒNThe code that you are afraid to touch is the code most in need of refactoring.”h]”hŒNThe code that you are afraid to touch is the code most in need of refactoring.”…””}”(hhçhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒ3A little organizing here and there goes a long way.”h]”hŒ3A little organizing here and there goes a long way.”…””}”(hhõhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒ.Put real thought into how you organize things.”h]”hŒ.Put real thought into how you organize things.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒ^Good code is readable code, where the structure is simple and leaves nowhere
for bugs to hide.”h]”hŒ^Good code is readable code, where the structure is simple and leaves nowhere
for bugs to hide.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hX„  Assertions are one of our most important tools for writing reliable code. If in
the course of writing a patchset you encounter a condition that shouldn't
happen (and will have unpredictable or undefined behaviour if it does), or
you're not sure if it can happen and not sure how to handle it yet - make it a
BUG_ON(). Don't leave undefined or unspecified behavior lurking in the codebase.”h]”hXŠ  Assertions are one of our most important tools for writing reliable code. If in
the course of writing a patchset you encounter a condition that shouldnâ€™t
happen (and will have unpredictable or undefined behaviour if it does), or
youâ€™re not sure if it can happen and not sure how to handle it yet - make it a
BUG_ON(). Donâ€™t leave undefined or unspecified behavior lurking in the codebase.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hXÎ  By the time you finish the patchset, you should understand better which
assertions need to be handled and turned into checks with error paths, and
which should be logically impossible. Leave the BUG_ON()s in for the ones which
are logically impossible. (Or, make them debug mode assertions if they're
expensive - but don't turn everything into a debug mode assertion, so that
we're not stuck debugging undefined behaviour should it turn out that you were
wrong).”h]”hXÔ  By the time you finish the patchset, you should understand better which
assertions need to be handled and turned into checks with error paths, and
which should be logically impossible. Leave the BUG_ON()s in for the ones which
are logically impossible. (Or, make them debug mode assertions if theyâ€™re
expensive - but donâ€™t turn everything into a debug mode assertion, so that
weâ€™re not stuck debugging undefined behaviour should it turn out that you were
wrong).”…””}”(hj-  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒVAssertions are documentation that can't go out of date. Good assertions are
wonderful.”h]”hŒXAssertions are documentation that canâ€™t go out of date. Good assertions are
wonderful.”…””}”(hj;  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K%hh¶hžhubhÊ)”}”(hŒeGood assertions drastically and dramatically reduce the amount of testing
required to shake out bugs.”h]”hŒeGood assertions drastically and dramatically reduce the amount of testing
required to shake out bugs.”…””}”(hjI  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K(hh¶hžhubhÊ)”}”(hŒ‡Good assertions are based on state, not logic. To write good assertions, you
have to think about what the invariants on your state are.”h]”hŒ‡Good assertions are based on state, not logic. To write good assertions, you
have to think about what the invariants on your state are.”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K+hh¶hžhubhÊ)”}”(hX7  Good invariants and assertions will hold everywhere in your codebase. This
means that you can run them in only a few places in the checked in version, but
should you need to debug something that caused the assertion to fail, you can
quickly shotgun them everywhere to find the codepath that broke the invariant.”h]”hX7  Good invariants and assertions will hold everywhere in your codebase. This
means that you can run them in only a few places in the checked in version, but
should you need to debug something that caused the assertion to fail, you can
quickly shotgun them everywhere to find the codepath that broke the invariant.”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K.hh¶hžhubhÊ)”}”(hX.  A good assertion checks something that the compiler could check for us, and
elide - if we were working in a language with embedded correctness proofs that
the compiler could check. This is something that exists today, but it'll likely
still be a few decades before it comes to systems programming languages. But we
can still incorporate that kind of thinking into our code and document the
invariants with runtime checks - much like the way people working in
dynamically typed languages may add type annotations, gradually making their
code statically typed.”h]”hX0  A good assertion checks something that the compiler could check for us, and
elide - if we were working in a language with embedded correctness proofs that
the compiler could check. This is something that exists today, but itâ€™ll likely
still be a few decades before it comes to systems programming languages. But we
can still incorporate that kind of thinking into our code and document the
invariants with runtime checks - much like the way people working in
dynamically typed languages may add type annotations, gradually making their
code statically typed.”…””}”(hjs  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K3hh¶hžhubhÊ)”}”(hŒ”Looking for ways to make your assertions simpler - and higher level - will
often nudge you towards making the entire system simpler and more robust.”h]”hŒ”Looking for ways to make your assertions simpler - and higher level - will
often nudge you towards making the entire system simpler and more robust.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K<hh¶hžhubhÊ)”}”(hŒGood code is code where you can poke around and see what it's doing -
introspection. We can't debug anything if we can't see what's going on.”h]”hŒ•Good code is code where you can poke around and see what itâ€™s doing -
introspection. We canâ€™t debug anything if we canâ€™t see whatâ€™s going on.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K?hh¶hžhubhÊ)”}”(hŒ²Whenever we're debugging, and the solution isn't immediately obvious, if the
issue is that we don't know where the issue is because we can't see what's
going on - fix that first.”h]”hŒ¼Whenever weâ€™re debugging, and the solution isnâ€™t immediately obvious, if the
issue is that we donâ€™t know where the issue is because we canâ€™t see whatâ€™s
going on - fix that first.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KBhh¶hžhubhÊ)”}”(hŒWe have the tools to make anything visible at runtime, efficiently - RCU and
percpu data structures among them. Don't let things stay hidden.”h]”hŒWe have the tools to make anything visible at runtime, efficiently - RCU and
percpu data structures among them. Donâ€™t let things stay hidden.”…””}”(hj«  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KFhh¶hžhubhÊ)”}”(hŒ”The most important tool for introspection is the humble pretty printer - in
bcachefs, this means `*_to_text()` functions, which output to printbufs.”h]”(hŒaThe most important tool for introspection is the humble pretty printer - in
bcachefs, this means ”…””}”(hj¹  hžhhŸNh NubhŒtitle_reference”“”)”}”(hŒ`*_to_text()`”h]”hŒ*_to_text()”…””}”(hjÃ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÁ  hj¹  ubhŒ& functions, which output to printbufs.”…””}”(hj¹  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KIhh¶hžhubhÊ)”}”(hXF  Pretty printers are wonderful, because they compose and you can use them
everywhere. Having functions to print whatever object you're working with will
make your error messages much easier to write (therefore they will actually
exist) and much more informative. And they can be used from sysfs/debugfs, as
well as tracepoints.”h]”hXH  Pretty printers are wonderful, because they compose and you can use them
everywhere. Having functions to print whatever object youâ€™re working with will
make your error messages much easier to write (therefore they will actually
exist) and much more informative. And they can be used from sysfs/debugfs, as
well as tracepoints.”…””}”(hjÛ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KLhh¶hžhubhÊ)”}”(hX  Runtime info and debugging tools should come with clear descriptions and
labels, and good structure - we don't want files with a list of bare integers,
like in procfs. Part of the job of the debugging tools is to educate users and
new developers as to how the system works.”h]”hX  Runtime info and debugging tools should come with clear descriptions and
labels, and good structure - we donâ€™t want files with a list of bare integers,
like in procfs. Part of the job of the debugging tools is to educate users and
new developers as to how the system works.”…””}”(hjé  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KRhh¶hžhubhÊ)”}”(hŒError messages should, whenever possible, tell you everything you need to debug
the issue. It's worth putting effort into them.”h]”hŒError messages should, whenever possible, tell you everything you need to debug
the issue. Itâ€™s worth putting effort into them.”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KWhh¶hžhubhÊ)”}”(hX¾  Tracepoints shouldn't be the first thing you reach for. They're an important
tool, but always look for more immediate ways to make things visible. When we
have to rely on tracing, we have to know which tracepoints we're looking for,
and then we have to run the troublesome workload, and then we have to sift
through logs. This is a lot of steps to go through when a user is hitting
something, and if it's intermittent it may not even be possible.”h]”hXÆ  Tracepoints shouldnâ€™t be the first thing you reach for. Theyâ€™re an important
tool, but always look for more immediate ways to make things visible. When we
have to rely on tracing, we have to know which tracepoints weâ€™re looking for,
and then we have to run the troublesome workload, and then we have to sift
through logs. This is a lot of steps to go through when a user is hitting
something, and if itâ€™s intermittent it may not even be possible.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KZhh¶hžhubhÊ)”}”(hX*  The humble counter is an incredibly useful tool. They're cheap and simple to
use, and many complicated internal operations with lots of things that can
behave weirdly (anything involving memory reclaim, for example) become
shockingly easy to debug once you have counters on every distinct codepath.”h]”hX,  The humble counter is an incredibly useful tool. Theyâ€™re cheap and simple to
use, and many complicated internal operations with lots of things that can
behave weirdly (anything involving memory reclaim, for example) become
shockingly easy to debug once you have counters on every distinct codepath.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kahh¶hžhubhÊ)”}”(hŒ$Persistent counters are even better.”h]”hŒ$Persistent counters are even better.”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kfhh¶hžhubhÊ)”}”(hXŠ  When debugging, try to get the most out of every bug you come across; don't
rush to fix the initial issue. Look for things that will make related bugs
easier the next time around - introspection, new assertions, better error
messages, new debug tools, and do those first. Look for ways to make the system
better behaved; often one bug will uncover several other bugs through
downstream effects.”h]”hXŒ  When debugging, try to get the most out of every bug you come across; donâ€™t
rush to fix the initial issue. Look for things that will make related bugs
easier the next time around - introspection, new assertions, better error
messages, new debug tools, and do those first. Look for ways to make the system
better behaved; often one bug will uncover several other bugs through
downstream effects.”…””}”(hj/  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khhh¶hžhubhÊ)”}”(hX8  Fix all that first, and then the original bug last - even if that means keeping
a user waiting. They'll thank you in the long run, and when they understand
what you're doing you'll be amazed at how patient they're happy to be. Users
like to help - otherwise they wouldn't be reporting the bug in the first place.”h]”hXB  Fix all that first, and then the original bug last - even if that means keeping
a user waiting. Theyâ€™ll thank you in the long run, and when they understand
what youâ€™re doing youâ€™ll be amazed at how patient theyâ€™re happy to be. Users
like to help - otherwise they wouldnâ€™t be reporting the bug in the first place.”…””}”(hj=  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kohh¶hžhubhÊ)”}”(hŒ+Talk to your users. Don't isolate yourself.”h]”hŒ-Talk to your users. Donâ€™t isolate yourself.”…””}”(hjK  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kthh¶hžhubhÊ)”}”(hŒŠUsers notice all sorts of interesting things, and by just talking to them and
interacting with them you can benefit from their experience.”h]”hŒŠUsers notice all sorts of interesting things, and by just talking to them and
interacting with them you can benefit from their experience.”…””}”(hjY  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kvhh¶hžhubhÊ)”}”(hŒ|Spend time doing support and helpdesk stuff. Don't just write code - code isn't
finished until it's being used trouble free.”h]”hŒ‚Spend time doing support and helpdesk stuff. Donâ€™t just write code - code isnâ€™t
finished until itâ€™s being used trouble free.”…””}”(hjg  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kyhh¶hžhubhÊ)”}”(hX.  This will also motivate you to make your debugging tools as good as possible,
and perhaps even your documentation, too. Like anything else in life, the more
time you spend at it the better you'll get, and you the developer are the
person most able to improve the tools to make debugging quick and easy.”h]”hX0  This will also motivate you to make your debugging tools as good as possible,
and perhaps even your documentation, too. Like anything else in life, the more
time you spend at it the better youâ€™ll get, and you the developer are the
person most able to improve the tools to make debugging quick and easy.”…””}”(hju  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K|hh¶hžhubhÊ)”}”(hX
  Be wary of how you take on and commit to big projects. Don't let development
become product-manager focused. Often time an idea is a good one but needs to
wait for its proper time - but you won't know if it's the proper time for an
idea until you start writing code.”h]”hX  Be wary of how you take on and commit to big projects. Donâ€™t let development
become product-manager focused. Often time an idea is a good one but needs to
wait for its proper time - but you wonâ€™t know if itâ€™s the proper time for an
idea until you start writing code.”…””}”(hjƒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hXE  Expect to throw a lot of things away, or leave them half finished for later.
Nobody writes all perfect code that all gets shipped, and you'll be much more
productive in the long run if you notice this early and shift to something
else. The experience gained and lessons learned will be valuable for all the
other work you do.”h]”hXG  Expect to throw a lot of things away, or leave them half finished for later.
Nobody writes all perfect code that all gets shipped, and youâ€™ll be much more
productive in the long run if you notice this early and shift to something
else. The experience gained and lessons learned will be valuable for all the
other work you do.”…””}”(hj‘  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K†hh¶hžhubhÊ)”}”(hXW  But don't be afraid to tackle projects that require significant rework of
existing code. Sometimes these can be the best projects, because they can lead
us to make existing code more general, more flexible, more multipurpose and
perhaps more robust. Just don't hesitate to abandon the idea if it looks like
it's going to make a mess of things.”h]”hX]  But donâ€™t be afraid to tackle projects that require significant rework of
existing code. Sometimes these can be the best projects, because they can lead
us to make existing code more general, more flexible, more multipurpose and
perhaps more robust. Just donâ€™t hesitate to abandon the idea if it looks like
itâ€™s going to make a mess of things.”…””}”(hjŸ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KŒhh¶hžhubhÊ)”}”(hX  Complicated features can often be done as a series of refactorings, with the
final change that actually implements the feature as a quite small patch at the
end. It's wonderful when this happens, especially when those refactorings are
things that improve the codebase in their own right. When that happens there's
much less risk of wasted effort if the feature you were going for doesn't work
out.”h]”hX“  Complicated features can often be done as a series of refactorings, with the
final change that actually implements the feature as a quite small patch at the
end. Itâ€™s wonderful when this happens, especially when those refactorings are
things that improve the codebase in their own right. When that happens thereâ€™s
much less risk of wasted effort if the feature you were going for doesnâ€™t work
out.”…””}”(hj­  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K’hh¶hžhubhÊ)”}”(hŒŒAlways strive to work incrementally. Always strive to turn the big projects
into little bite sized projects that can prove their own merits.”h]”hŒŒAlways strive to work incrementally. Always strive to turn the big projects
into little bite sized projects that can prove their own merits.”…””}”(hj»  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K™hh¶hžhubhÊ)”}”(hŒ|Instead of always tackling those big projects, look for little things that
will be useful, and make the big projects easier.”h]”hŒ|Instead of always tackling those big projects, look for little things that
will be useful, and make the big projects easier.”…””}”(hjÉ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kœhh¶hžhubhÊ)”}”(hX®  The question of what's likely to be useful is where junior developers most
often go astray - doing something because it seems like it'll be useful often
leads to overengineering. Knowing what's useful comes from many years of
experience, or talking with people who have that experience - or from simply
reading lots of code and looking for common patterns and issues. Don't be
afraid to throw things away and do something simpler.”h]”hX¶  The question of whatâ€™s likely to be useful is where junior developers most
often go astray - doing something because it seems like itâ€™ll be useful often
leads to overengineering. Knowing whatâ€™s useful comes from many years of
experience, or talking with people who have that experience - or from simply
reading lots of code and looking for common patterns and issues. Donâ€™t be
afraid to throw things away and do something simpler.”…””}”(hj×  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KŸhh¶hžhubhÊ)”}”(hŒœTalk about your ideas with your fellow developers; often times the best things
come from relaxed conversations where people aren't afraid to say "what if?".”h]”hŒ¢Talk about your ideas with your fellow developers; often times the best things
come from relaxed conversations where people arenâ€™t afraid to say â€œwhat if?â€.”…””}”(hjå  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K¦hh¶hžhubhÊ)”}”(hŒDon't neglect your tools.”h]”hŒDonâ€™t neglect your tools.”…””}”(hjó  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K©hh¶hžhubhÊ)”}”(hX‡  The most important tools (besides the compiler and our text editor) are the
tools we use for testing. The shortest possible edit/test/debug cycle is
essential for working productively. We learn, gain experience, and discover the
errors in our thinking by running our code and seeing what happens. If your
time is being wasted because your tools are bad or too slow - don't accept it,
fix it.”h]”hX‰  The most important tools (besides the compiler and our text editor) are the
tools we use for testing. The shortest possible edit/test/debug cycle is
essential for working productively. We learn, gain experience, and discover the
errors in our thinking by running our code and seeing what happens. If your
time is being wasted because your tools are bad or too slow - donâ€™t accept it,
fix it.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K«hh¶hžhubhÊ)”}”(hX  Put effort into your documentation, commit messages, and code comments - but
don't go overboard. A good commit message is wonderful - but if the information
was important enough to go in a commit message, ask yourself if it would be
even better as a code comment.”h]”hX	  Put effort into your documentation, commit messages, and code comments - but
donâ€™t go overboard. A good commit message is wonderful - but if the information
was important enough to go in a commit message, ask yourself if it would be
even better as a code comment.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K²hh¶hžhubhÊ)”}”(hX-  A good code comment is wonderful, but even better is the comment that didn't
need to exist because the code was so straightforward as to be obvious;
organized into small clean and tidy modules, with clear and descriptive names
for functions and variables, where every line of code has a clear purpose.”h]”hX/  A good code comment is wonderful, but even better is the comment that didnâ€™t
need to exist because the code was so straightforward as to be obvious;
organized into small clean and tidy modules, with clear and descriptive names
for functions and variables, where every line of code has a clear purpose.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K·hh¶hžhubeh}”(h]”Œbcachefs-coding-style”ah ]”h"]”Œbcachefs coding style”ah$]”h&]”uh1h´hhhž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”jV  Œ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”}”j0  j-  sŒ	nametypes”}”j0  ‰sh}”j-  h¶sŒ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.