Rename fail! to panic!

[steveklabnik]

This in-progress PR implements #17489.

I made the code changes in this commit, next is to go through alllllllll the documentation and fix various things.

• Rename column headings as appropriate, # Panics for panic conditions and # Errors for Results.
• clean up usage of words like 'fail' in error messages

Anything else to add to the list, @aturon ? I think I should leave the actual functions with names like slice_or_fail alone, since you'll get to those in your conventions work?

I'm submitting just the code bits now so that we can see it separately, and I also don't want to have to keep re-building rust over and over again if I don't have to 😉

Listing all the bits so I can remember as I go:

• compiler-rt
• compiletest
• doc
• driver
• etc
• grammar
• jemalloc
• liballoc
• libarena
• libbacktrace
• libcollections
• libcore
• libcoretest
• libdebug
• libflate
• libfmt_macros
• libfourcc
• libgetopts
• libglob
• libgraphviz
• libgreen
• libhexfloat
• liblibc
• liblog
• libnative
• libnum
• librand
• librbml
• libregex
• libregex_macros
• librlibc
• librustc
• librustc_back
• librustc_llvm
• librustdoc
• librustrt
• libsemver
• libserialize
• libstd
• libsync
• libsyntax
• libterm
• libtest
• libtime
• libunicode
• liburl
• libuuid
• llvm
• rt
• test

[rust-highfive]

Warning

• These commits modify unsafe code. Please review it carefully!

[aturon]

@steveklabnik Thanks for getting started on this! Another item to add to the list: renaming other uses of fail in function and parameter names. This is less important, but it'd be good to do and probably easiest as part of the same pass.

[steveklabnik]

I am unsure of the changes in libcollections/vec.rs, I think that's talking about panic? But not 100% sure.

[steveklabnik]

Whew, rebased. That sucked.

[Gankra]

Everything in vec looks good to me

[steveklabnik]

@aturon i'm guessing that that would be 'deprecate and make a new one'? Like the slice_or_fail methods in libcollections, for example?

[steveklabnik]

Unsure how to rephrase

//! The core library cannot define failure, but it does *declare* failure. This

[steveklabnik]

I guess libcore's failure isn't really the same thing? it's like, hardcore failure, right?

[steveklabnik]

(speaking of src/libcore/failure.rs specifically)

[steveklabnik]

checking off libsemver because it's already in an external crate

[steveklabnik]

same for all the other ones which were moved out

[aturon]

@steveklabnik

@aturon i'm guessing that that would be 'deprecate and make a new one'? Like the slice_or_fail methods in libcollections, for example?

I'm not sure if something got lost in github, but it's not clear what this is referring to?

[aturon]

@steveklabnik

Unsure how to rephrase

   //! The core library cannot define failure, but it does *declare* failure. This

The "failure" here is referring to the implementation of fail!, so this should be talking about panicking instead (and the file should be renamed as well.)

[aturon]

Oh, and yes, it's fine to focus on doc comments and leave actual function/parameter names to API stabilization.

[steveklabnik]

Yeah, I was talking about the method and parameter names.

[steveklabnik]

Whew! Getting there! I've knocked out all the ones that have no messages, so the ones that left all need work.

[steveklabnik]

aaaand rebased

[aturon]

This is amazing... please ping me on IRC when you're done and I'll try to do the final review quickly to avoid further rebasing pain.

[steveklabnik]

No worries, after the rebase involving the removal of libdebug (imagine how many format strings went from {:?} to {}) it's not been that big of a deal :)

[steveklabnik]

I'm guessing i'll be done in a day or two. been working on other stuff too since this is kind of mind-numbing.

[steveklabnik]

std::task::failing should probably get re-named with the conventions update, @aturon

[steveklabnik]

In the libcore stuff, I did change the name of the implementation of panic. I left the others alone though /cc @aturon

[steveklabnik]

Okay! This is ready for a preliminary review, @aturon .

This may not currently compile, I haven't been able to test because I'm literally waiting for the internet to be installed in my new place within the next few hours, and I'm not going to download a snapshot over tethering 😉 I'll be able to double check that this actually works once that's set up.

[steveklabnik]

This now compiles and stuff correctly. Woo!

[aturon]

OK, this looks basically good, but I've commented on a bunch of places where I think "fail" or "failure" is actually the right term.

After that, please squash down to a couple commits, and add a [breaking-change] marker along with instructions for how people should update their code.

Thanks again!