• Owl@mander.xyz
    link
    fedilink
    arrow-up
    6
    ·
    9 hours ago

    Joke’s on you, the docs don’t exist or are so outdated that they don’t even compile

    • Agent641@lemmy.world
      link
      fedilink
      arrow-up
      4
      ·
      8 hours ago

      Reconfabulate the tridepodictaphone by nabulizing the fromgulan with kreevus. If stufingus brawes, then hyfangle the natriuminutaur.

      Basic 17th year psycoders can do this.

    • Jankatarch@lemmy.world
      link
      fedilink
      arrow-up
      20
      ·
      edit-2
      21 hours ago

      It doesn’t work the first time but you copy paste from the docs example instead of typing the example and it works now

      • ChogChog@lemmy.world
        link
        fedilink
        arrow-up
        7
        ·
        17 hours ago

        Ohhh, so that’s why it’s called Docker!

        As in “It works on my system” so they just copied and pasted the commands for you.

      • Probius@sopuli.xyz
        link
        fedilink
        English
        arrow-up
        14
        ·
        21 hours ago

        I’ve had times where I was going through my code and the docs code step by step to see where they logically differed and found that I was doing all the same things, but my code didn’t work and copy-pasting their code did. Make it make sense!

        • aaaa@piefed.world
          link
          fedilink
          English
          arrow-up
          15
          ·
          19 hours ago

          Let me count the ways it has been for me… Capitalization, using -, not using -, wrong quotes, mismatched quotes, no quotes, reading the command the same wrong way about five times and typing it that way. Well this could take forever to list them all.

          I just copy paste first now. That way I learn none of the commands or syntax at all

        • raspberriesareyummy@lemmy.world
          link
          fedilink
          arrow-up
          5
          ·
          20 hours ago

          Been there, found undefined behavior where there should not be any. Imagine a function that takes a bool param with the following code, but neither branch gets executed:

          if (b)
             doStuffForTrue();
          if (!b)
             doStuffForFalse();
          

          In a function that is passed an uninitialized bool parameter, in gcc compiler, both branches can get executed even when b is const. Reason: uninitialized bool in gcc can have values of a random integer, and while if(b) {} else ({} is guaranteed to execute only one branch, bool evaluations of a bool value take a “shortcut” that only has defined behavior with an initialized bool.

          Same code with an uninitialized integer works as expected, btw.

          • zerofk@lemmy.zip
            link
            fedilink
            arrow-up
            2
            ·
            12 hours ago

            Don’t blame this on gcc or the library/function author - it is 100% user (i.e. programmer) error. Uninitialised memory of any type is undefined behaviour in the C and C++ abstract machine. That means optimising compilers can assume it does not exist.

            For example, the compiler could see that your ‘b’ is never initialised. Therefore, using it would be undefined behaviour. So, the optimiser can assume it is never used, and it is as if that code simply does not exist: the behaviour you saw.

            I’m not saying that is what happened, nor that it will always happen, but it is a possibility.

            • raspberriesareyummy@lemmy.world
              link
              fedilink
              arrow-up
              1
              ·
              edit-2
              9 hours ago

              Don’t blame this on gcc or the library/function author - it is 100% user (i.e. programmer) error. Uninitialised memory of any type is undefined behaviour in the C and C++ abstract machine. That means optimising compilers can assume it does not exist.

              I absolutely do blame this on the C++ standard being not specific enough, specifically for the way in how I learned about this: When writing a trivial function, you would never expect that - for a bool parameter - an “if (b)” branch can be executed as well as an “if (!b)” branch.

              So basically, this mechanic sabotages input data validation in functions that test whether plausible parameters were provided. The problem is that a function you write that is bug-free and “perfect code” - despite input data validation - can exhibit undefined behavior due to an uninitialized bool type parameter. Something that can not happen with other uninitialized trivial (numeric) data types (int, float). Simply due to the way boolean checks are translated to x86 assembly:

              Here’s an example: https://godbolt.org/z/T3f9csohd

              Note the assembly lines 176-182: The only difference for the “if (!b)” check is that the lowest bit of the boolean is flipped with an xor - which assumes about the implementation that a boolean can never hold values other than 0 or 1. Which I - as a naive user - also assumed until this happened. Correction: I assumed that negating a bool would result in the inverse boolean value.

              So the problem boils down to: The value range of any given (built-in) numerical data type fully encloses the value range that an uninitialized variable of that type can have. This is not necessarily true for boolean: In g++, the value range is [0;1] and the range of an uninitialized bool is [0;255].

              Accordingly, I would expect the C++ standard to fix this by stating that an uninitialized bool must have a value for which only one of two conditions evluates to true: b or !b, but not both.

  • Croquette@sh.itjust.works
    link
    fedilink
    arrow-up
    24
    arrow-down
    1
    ·
    21 hours ago

    The documentation is usually dog shit.

    The corporate culture does not allow appropriate time for the documentation as it is considered something that cost money without a quantifiable gain.

    It permeates in the FOSS space as well since writing good documentation is a skill and it is not fostered in corporations. So devs start great projects with terrible documentation.

    • raspberriesareyummy@lemmy.world
      link
      fedilink
      arrow-up
      15
      ·
      20 hours ago

      One way to contribute to FOSS is to improve bad documentation. You are correct, of course, and lazy devs write bad code if they do not cultivate good documentation - imho.

    • ChogChog@lemmy.world
      link
      fedilink
      arrow-up
      5
      ·
      17 hours ago

      Does anyone know of any good resources on writing good documentation? It’s a thing I’m weirdly passionate about and absolutely want to get better at for my own sanity and for others as well if I can contribute.

      But it seems like it’s a very under discussed subject…

      Veronica Explains has a really good video talking about how much of a dead skill it is now from the standards it used to be.

  • NeatNit@discuss.tchncs.de
    link
    fedilink
    arrow-up
    33
    arrow-down
    1
    ·
    23 hours ago

    The funniest thing to me is that any good manual would just say “DO NOT USE SOCKS AND FLIP FLOPS SIMULTANEOUSLY”

  • Kystael@lemmy.world
    link
    fedilink
    arrow-up
    5
    ·
    18 hours ago

    Then the doc is so complicated that you spend hours reading stuff just to understand if the page is actually related or not. Then at some point you get bored try something randomly and it works.

  • JasonDJ@lemmy.zip
    link
    fedilink
    arrow-up
    15
    ·
    1 day ago

    Then you look back at your notes a couple years later and you’re like “I still don’t understand wtf I did it that way”.

  • UnfortunateShort@lemmy.world
    link
    fedilink
    English
    arrow-up
    4
    arrow-down
    1
    ·
    edit-2
    17 hours ago

    Tbf, often there either is no proper one, or you don’t know where to find it. Or there is just tons to unpack, because one thing leads to another and suddenly you have to read like 10.

    To give you an example: I just wanted to create a new btrfs software RAID and dissolve my old one, but without loosing the data or redundancy in the process. To do so, I had to create a new partition table, of course not before using tools to find the right device, add a LUKS2 partition, find its UUID, unlock that partition, add a btrfs partition, mount that partition, copy all data over, then generate a keyfile for auto-unlock, add that to the LUKS, add the according crypttab line, remove a drive from the former raid, not before running a balance of course, then also create LUKS on that, find the UUID again, open that as well, add the keyfile again, add another crypttab line, adding the mapper to the btrfs partition, running a balance that creates a RAID 10, adding an fstab entry for auto-mount, runnning dracut and set up btrfs maintenance.

    Even just describing the process is a chore. Imagine trying to learn every stept, one by one, from the manuals.

    Edit: Some fixes and steps I skipped added. In case anyone is wondering what the heck I’m doing: I am moving from a RAID 1 with 2 disks to an encrypted RAID 10 with eventually 4

  • Brkdncr@lemmy.world
    link
    fedilink
    arrow-up
    12
    ·
    edit-2
    21 hours ago

    It amazes me to see people do everything except 1) rtfm or 2) contact the support line that’s already paid for.

    Edit: apparently my coworkers are in this thread.

  • Dew@feddit.nl
    link
    fedilink
    arrow-up
    5
    ·
    22 hours ago

    I enjoy it more to figure out on my own. Kinda like disassembling stuff to see how it works and then put it back together. Reading the manual is like copying answers